Skip to main content

Reference

Catalog Management API Payload​

Example JSON Payload​

Click to expand JSON Payload Example
{
"scope": {
"business_ids": [
"string"
]
},
"items": [
{
"merchant_supplied_item_id": "string",
"name": "string",
"description": "string",
"product_traits": [
"ALCOHOL"
],
"other_identifiers": [
{
"identifier_type": "UPC",
"identifier_value": "string"
}
],
"images": [
{
"url": "string",
"sort_id": 0
}
],
"size": {
"details": {
"dimensions": {
"length": {
"value": 0,
"unit": "inch"
},
"width": {
"value": 0,
"unit": "inch"
},
"height": {
"value": 0,
"unit": "inch"
}
},
"weight": {
"value": 0,
"unit": "lbs"
},
"volume": {
"value": 0,
"unit": "oz"
},
"product_specific_size_definition": {
"value": "string",
"description": "string"
}
},
"pack_size_details": {
"count_per_pack": 0,
"per_item_size_details": {
"dimensions": {
"length": {
"value": 0,
"unit": "inch"
},
"width": {
"value": 0,
"unit": "inch"
},
"height": {
"value": 0,
"unit": "inch"
}
},
"weight": {
"value": 0,
"unit": "lbs"
},
"volume": {
"value": 0,
"unit": "oz"
},
"product_specific_size_definition": {
"value": "string",
"description": "string"
}
}
}
},
"weighted_item_info": {
"average_weight_per_each": 0,
"average_weight_measurement_unit": "ea",
"shop_by_measurement_unit": "kg",
"price_by_measurement_unit": "kg"
},
"brand_info": {
"name": "string"
},
"program_eligibility": [
"SNAP"
],
"item_categorizations": [
{
"category": {
"name": "string",
"sub_category": {}
}
}
]
}
]
}

Overview of Parameters​

Parameter NameTypeDescriptionAccepted ValuesRequired
merchant_supplied_item_idstringMerchant supplied ID to identify an item-Yes
namestringName of the item-Yes
descriptionstringDescription of the item-No
product_traitsArray of stringsSpecifies the type of product(s)"ALCOHOL," "MEDICATION," "WEIGHTED"No
other_identifiersArray of objectsOther identifiers associated with the item-No
imagesArray of objectsImages of the item-Yes
sizeobjectSize of the item-No
weighted_item_infoobjectAttributes related to items sold by weights-No
brand_infoobjectBrand of the item if applicable-No
program_eligibilityArray of stringsProgram eligibility of the item"SNAP," "HSA," "FSA"No
item_categorizationsArray of objectsMerchant item taxonomy-No

Object Tables​

Other Identifiers Object​

Parameter NameTypeDescriptionAccepted ValuesRequired
identifier_typestringType of identifier"UPC," "PLU," "NSC2," "GTIN"No
identifier_valuestringIdentifier value-No

Images Object​

Parameter NameTypeDescriptionAccepted ValuesRequired
urlstringItem image URL in JPG or PNG format-Yes
sort_idintegerOrder in which images should be displayed-No

Size Object​

Parameter NameTypeDescriptionAccepted ValuesRequired
detailsobjectSize details of the item-No
pack_size_detailsobjectItem size details per pack-No
Size Details Object​
Parameter NameTypeDescriptionAccepted ValuesRequired
dimensionsobjectDimension of the product-No
weightobjectWeight of the product-No
volumeobjectVolume of the product-No
product_specific_size_definitionobjectProduct-specific size definition-No
Dimensions Object​
Parameter NameTypeDescriptionAccepted ValuesRequired
lengthobjectLength of the product-No
widthobjectWidth of the product-No
heightobjectHeight of the product-No
Weight Object​
Parameter NameTypeDescriptionAccepted ValuesRequired
valuenumberWeight value of the product-No
unitstringUnit of weight (lbs, gm)"lbs," "gm"No
Volume Object​
Parameter NameTypeDescriptionAccepted ValuesRequired
valuenumberVolume value of the product-No
unitstringUnit of volume (oz)"oz"No
Product-Specific Size Definition Object​
Parameter NameTypeDescriptionAccepted ValuesRequired
valuestringValue of the product-specific size definition-No
descriptionstringDescription of the product-specific size-No
Pack Size Details Object​
Parameter NameTypeDescriptionAccepted ValuesRequired
count_per_packnumberNumber of items per pack-No
per_item_size_detailsobjectSize details per item in the pack-No
Per Item Size Details Object​
Parameter NameTypeDescriptionAccepted ValuesRequired
dimensionsobjectDimension of the product-No
weightobjectWeight of the product-No
volumeobjectVolume of the product-No
product_specific_size_definitionobjectProduct-specific size definition-No

Weighted Item Info Object​

Parameter NameTypeDescriptionAccepted ValuesRequired
average_weight_per_eachnumberAverage weight per each item or pack-No
average_weight_measurement_unitstringUnit of measurement (ea, kg, lb, gm, oz)"ea," "kg," "lb," "gm," "oz"No
shop_by_measurement_unitstringHow the item is shown to customers"kg," "lb," "gm," "oz"No
price_by_measurement_unitstringHow the item is priced"kg," "lb," "gm," "oz"No

Brand Info Object​

Parameter NameTypeDescriptionAccepted ValuesRequired
namestringName of the brand-No

Category Object​

Parameter NameTypeDescriptionAccepted ValuesRequired
namestringName of the cateogry-No
sub_categoryobjectRecursive object allowing for multiple levels of cateogry data-No