Get Catalog List

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

Returns a list of CatalogObjects that includesnall objects of a set of desired types (for example, all CatalogItemnand CatalogTax objects) in the catalog. The types parameternis specified as a comma-separated list of valid CatalogObject types:nITEM, 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 examplenITEM,ITEM_VARIATION,CATEGORY.nnThe legal values are taken from the CatalogObjectTypenenumeration, namely ITEM, ITEM_VARIATION, CATEGORY, DISCOUNT, TAX,nMODIFIER, or MODIFIER_LIST.