Retrieve a category
Retrieves a category, its options and a complete set of choices for them.
Not every combination of option values can be made. To find one that can:
- Call with
selections: {}. The response fills in defaults. If the returnedselectionssuits you andcanManufactureistrue, use it. - To change an option, add your choice to
selectionsand call again. Choose only values withavailable: true. - Repeat until the returned
selectionssuits you andcanManufactureistrue.
If you choose only available values, the result can always be made. If the values you send cannot be made together, canManufacture is false. The values you sent that come back with available: false are the ones in conflict; replace one with an available value and call again.
In a print category, pass the returned selections to products/create. In a jewelry category, the options only show what is possible: products/generate chooses the values from your prompt, and products/create refuses the category.
startingPrice is the lowest price in the category. It does not depend on the values you send.
Authorizations
Body
Response
OK
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.