<- Catalog API

Catalog API

Batch retrieve catalog objects



Returns a set of objects based on the provided ID.

Each CatalogItem returned in the set includes all of its child information including: all of its CatalogItemVariation objects, references to its CatalogModifierList objects, and the ids of any CatalogTax objects that apply to it.

Try in API Explorer
Link to section

Request body

Example code

Link to section


string [ ]


The IDs of the CatalogObjects to be retrieved.

Link to section



If true, the response will include additional objects that are related to the requested objects. Related objects are defined as any objects referenced by ID by the results in the objects field of the response. These objects are put in the related_objects field. Setting this to true is helpful when the objects are needed for immediate display to a user. This process only goes one level deep. Objects referenced by the related objects will not be included. For example,

if the objects field of the response contains a CatalogItem, its associated CatalogCategory objects, CatalogTax objects, CatalogImage objects and CatalogModifierLists will be returned in the related_objects field of the response. If the objects field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the related_objects field of the response.

Default value: false

Link to section




The specific version of the catalog objects to be included in the response. This allows you to retrieve historical versions of objects. The specified version value is matched against the CatalogObjects' version attribute. If not included, results will be from the current version of the catalog.

Link to section



Indicates whether to include (true) or not (false) in the response deleted objects, namely, those with the is_deleted attribute set to true.

Link to section

Response fields

Link to section


Any errors that occurred during the request.

Link to section


A list of CatalogObjects returned.

Link to section


A list of CatalogObjects referenced by the object in the objects field.