Categories

Retrieve a category

Retrieves a category and its options. Not every combination of option values can be made: send the values you have decided, in any number, and each value comes back with available, whether some product that can be made has that value together with every value you sent for the other options.

Walk to any product without guessing, one call for each value you add:

Call with selections: {}. If the returned selections suits you, pass it to products.create.
Otherwise pick a value with available: true for an option you have not sent, add it to selections, and call again.
Repeat until selections suits you.

Choosing only available values never dead-ends, and every product that can be made is reachable in any order. If the values you send cannot be made together, canManufacture is false: the values you sent that are marked unavailable are the conflict, and the available values of those options are the ways out.

POST

/

categories

/

get

Retrieve a category

curl --request POST \
  --url https://platform.arcade.ai/v1/categories/get \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "categoryId": "<string>",
  "selections": {}
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({categoryId: '<string>', selections: {}})
};

fetch('https://platform.arcade.ai/v1/categories/get', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://platform.arcade.ai/v1/categories/get"

payload = {
    "categoryId": "<string>",
    "selections": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "categoryId": "<string>",
  "name": "<string>",
  "options": [
    {
      "key": "<string>",
      "label": "<string>",
      "values": [
        {
          "value": "<string>",
          "label": "<string>",
          "isDefault": true,
          "available": true
        }
      ]
    }
  ],
  "selections": {},
  "canManufacture": true
}

Authorizations

Authorization

string

header

required

An API key from Settings → API keys in Arcade Studio.

Body

application/json

categoryId

string

required

Category ID, from categories.list

Minimum string length: 1

selections

object

The values you have decided, option key to option value, in any number including none; options you leave out are open

Show child attributes

Response

200 - application/json

OK

categoryId

string

required

Category ID, from categories.list

Minimum string length: 1

name

string

required

options

object[]

required

Show child attributes

selections

object

required

A complete selection that keeps every value you sent: each open option takes its default where that can still be made, else another available value. Pass it to products.create when canManufacture is true

Show child attributes

canManufacture

boolean

required

Whether selections can be made; products.create uses the lowest-priced maker that can make it. False when the values you sent cannot be made together, and selections then fills the open options with their defaults

Retrieve a category

curl --request POST \
  --url https://platform.arcade.ai/v1/categories/get \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "categoryId": "<string>",
  "selections": {}
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({categoryId: '<string>', selections: {}})
};

fetch('https://platform.arcade.ai/v1/categories/get', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://platform.arcade.ai/v1/categories/get"

payload = {
    "categoryId": "<string>",
    "selections": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "categoryId": "<string>",
  "name": "<string>",
  "options": [
    {
      "key": "<string>",
      "label": "<string>",
      "values": [
        {
          "value": "<string>",
          "label": "<string>",
          "isDefault": true,
          "available": true
        }
      ]
    }
  ],
  "selections": {},
  "canManufacture": true
}