Qodex.ai

Get Catalog List

GET {{baseUrl}}/v2/catalog/list?cursor=<string>&types=<string>

Returns a list of CatalogObjects that includes all objects of a set of desired types (for example, all CatalogItem and CatalogTax objects) in the catalog. The types parameter is specified as a comma-separated list of valid CatalogObject types: ITEM, ITEM_VARIATION, MODIFIER, MODIFIER_LIST, CATEGORY, DISCOUNT, TAX.

Request Params

KeyDatatypeRequiredDescription
cursorstring
typesstringAn optional case-insensitive, comma-separated list of object types to retrieve, for example
ITEM,ITEM_VARIATION,CATEGORY.

The legal values are taken from the CatalogObjectType enumeration, namely &quot;ITEM&quot;, &quot;ITEM_VARIATION&quot;, &quot;CATEGORY&quot;, &quot;DISCOUNT&quot;, &quot;TAX&quot;, &quot;MODIFIER&quot;, or &quot;MODIFIER_LIST&quot;. |