Skip to main content
POST
Retrieve a category

Authorizations

Authorization
string
header
required

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

Body

application/json
categoryId
string
required

The category's ID, from categories/list.

Minimum string length: 1
selections
object

Your choices so far, as option key to option value. Send any number, including none. Arcade fills in the options you leave out.

Response

200 - application/json

OK

categoryId
string
required

The category's ID, from categories/list.

Minimum string length: 1
name
string
required

The category's name.

options
object[]
required
selections
object
required

The choices to build with: every value you sent, plus a value for the options you left out where one fits. That value is the option's default where possible, otherwise another available value. In a print category, pass it to products/create when canManufacture is true.

canManufacture
boolean
required

Whether a maker can make a product with selections. False when the values you sent cannot be made together; selections then holds your values plus the defaults for the rest. In a print category, products/create uses the lowest-priced maker that can make the product.

startingPrice
object | null
required

The lowest price in the category. It is a starting price, not a quote: a product's own price can differ, for example for your account or after a price change. products/get returns a product's price. Null when no price is available, including in every jewelry category. Null never means free.

world
enum<string>
required

The kind of product. print: a pattern printed on a product; make it from a pattern with products/create, or from a prompt with products/generate. jewelry: a piece of jewelry; make it only with products/generate.

Available options:
print,
jewelry
category
object

The group this category belongs to, such as Rings for Dainty Diamond Ring. Absent when it has no group.