RetrieveCatalogObject
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.
Path parameters
The object ID of any type of catalog objects to be retrieved.
Query parameters
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
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.
Specifies whether or not to include the path_to_root list for each returned category instance. The path_to_root list consists of CategoryPathToRootNode objects and specifies the path that starts with the immediate parent category of the returned category and ends with its root category. If the returned category is a top-level category, the path_to_root list is empty and is not returned in the response payload.
Response
Success
Example response
{
"object": {
"id": "W62UWFY35CWMYGVWK6TWJDNI",
"is_deleted": false,
"item_data": {
"categories": [
{
"id": "BJNQCF2FJ6S6UIDT65ABHLRX",
"ordinal": 0
}
],
"description": "Hot Leaf Juice",
"name": "Tea",
"tax_ids": [
"HURXQOOAIC4IZSI2BEXQRYFY"
],
"variations": [
{
"id": "2TZFAOHWGG7PAK2QEXWYPZSP",
"is_deleted": false,
"item_variation_data": {
"item_id": "W62UWFY35CWMYGVWK6TWJDNI",
"name": "Mug",
"ordinal": 0,
"price_money": {
"amount": 150,
"currency": "USD"
},
"pricing_type": "FIXED_PRICING"
},
"present_at_all_locations": true,
"type": "ITEM_VARIATION",
"updated_at": "2016-11-16T22:25:24.878Z",
"version": 1479335124878
}
]
},
"present_at_all_locations": true,
"type": "ITEM",
"updated_at": "2016-11-16T22:25:24.878Z",
"version": 1479335124878
},
"related_objects": [
{
"category_data": {
"name": "Beverages"
},
"id": "BJNQCF2FJ6S6UIDT65ABHLRX",
"is_deleted": false,
"present_at_all_locations": true,
"type": "CATEGORY",
"updated_at": "2016-11-16T22:25:24.878Z",
"version": 1479335124878
},
{
"id": "HURXQOOAIC4IZSI2BEXQRYFY",
"is_deleted": false,
"present_at_all_locations": true,
"tax_data": {
"calculation_phase": "TAX_SUBTOTAL_PHASE",
"enabled": true,
"inclusion_type": "ADDITIVE",
"name": "Sales Tax",
"percentage": "5.0"
},
"type": "TAX",
"updated_at": "2016-11-16T22:25:24.878Z",
"version": 1479335124878
}
]
}