<- Catalog API

Catalog API

Retrieve catalog object

GET

 /v2/catalog/object/{object_id}

Returns a single CatalogItem as a CatalogObject based on the provided ID.

The returned object includes all of the relevant CatalogItem information including: CatalogItemVariation children, references to its CatalogModifierList objects, and the ids of any CatalogTax objects that apply to it.

Permissions:ITEMS_READ
Try in API Explorer
Link to section

Path parameters

Example code

Link to section

object_id

string

Required

The object ID of any type of catalog objects to be retrieved.

Link to section

Query parameters

Link to section

include_related_objects

boolean

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

catalog_version

integer(64-bit)

Beta

Requests objects as of a specific version of the catalog. This allows you to retrieve historical versions of objects. The value to retrieve a specific version of an object can be found in the version field of CatalogObjects. If not included, results will be from the current version of the catalog.

Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Show attributes
Link to section

object

The CatalogObjects returned.

Show attributes
Link to section

related_objects

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

Show attributes