Management API
- GETGet Products for the App
- POSTCreate product
- GETGet product
- DELDelete product
- PATCHUpdate product
- PUTAdd attribute to product
- DELRemove attribute from product
- GETLists all categories a product is part of
- PUTAdd product to category
- DELRemove category relationship
- PUTAdds collection to a product
- DELRemoves a collection from a product
- PUTAdds single collection to a product
- GETRetrieve product images
- PUTUpload product image
- DELDelete a product image
- PUTAdd tag to product
- DELRemove tag from product
- POSTBulk Create products
- DELBulk Delete products
- PATCHBulk Update product
- GETGet product by product number
- GET
Shopper API
Auth API
Error
Copy
A valid request URL is required to generate request examplesCopy
{
"data": [
{
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"brand": {
"id": "<string>",
"name": "<string>",
"series": {
"id": "<string>",
"name": "<string>",
"slug": "<string>"
},
"slug": "<string>"
},
"categories": [
{
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"children": [
{
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"children": "<array>",
"created_at": "<string>",
"id": "<string>",
"name": "<string>",
"parent_id": "<string>",
"redirects": [
{
"id": "<string>",
"item_id": "<string>",
"locale": "<string>",
"new_slug": "<string>",
"old_slug": "<string>",
"type": "product"
}
],
"slug": "<string>",
"sort_order": 123,
"status": "<string>",
"translations": {
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"slug": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"uri": "<string>"
}
],
"created_at": "<string>",
"id": "<string>",
"name": "<string>",
"order": 123,
"parent_id": "<string>",
"redirects": [
{
"id": "<string>",
"item_id": "<string>",
"locale": "<string>",
"new_slug": "<string>",
"old_slug": "<string>",
"type": "product"
}
],
"slug": "<string>",
"sort_order": 123,
"status": "<string>",
"translations": {
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"slug": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"uri": "<string>"
}
],
"collections": [
{
"slug": "<string>",
"status": "active",
"children": [
{
"slug": "<string>",
"status": "active",
"children": "<array>",
"created_at": "<string>",
"id": "<string>",
"parent_id": "<string>",
"redirects": [
{
"id": "<string>",
"item_id": "<string>",
"locale": "<string>",
"new_slug": "<string>",
"old_slug": "<string>",
"type": "product"
}
],
"title": "<string>",
"translations": {
"slug": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"title": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"uri": "<string>"
}
],
"created_at": "<string>",
"id": "<string>",
"order": 123,
"parent_id": "<string>",
"redirects": [
{
"id": "<string>",
"item_id": "<string>",
"locale": "<string>",
"new_slug": "<string>",
"old_slug": "<string>",
"type": "product"
}
],
"title": "<string>",
"translations": {
"slug": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"title": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"uri": "<string>"
}
],
"created_at": "<string>",
"custom": {},
"description": "<string>",
"exclude_from_feeds": true,
"files": [
{
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"created_at": "<string>",
"folder_id": "<string>",
"id": "<string>",
"title": "<string>",
"translations": {
"title": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"type": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"type": "<string>",
"updated_at": "<string>",
"url": "<string>"
}
],
"html_description": "<string>",
"html_short_description": "<string>",
"id": "<string>",
"images": [
{
"alt": "<string>",
"app_id": "<string>",
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"blurhash": "<string>",
"copyright": "<string>",
"custom": {},
"folder_id": "<string>",
"id": "<string>",
"priority": 123,
"status": "<string>",
"title": "<string>",
"translations": {
"alt": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"copyright": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"title": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"url": "<string>"
}
],
"market_status": [
{
"created_at": "<string>",
"market_id": "<string>",
"market_slug": "<string>",
"status": "<string>",
"store_group_id": "<string>",
"store_group_slug": "<string>",
"updated_at": "<string>"
}
],
"markets": [
{
"active": true,
"country_codes": [
"<string>"
],
"created_at": "<string>",
"currency_code": "<string>",
"id": "<string>",
"locale": "<string>",
"name": "<string>",
"slug": "<string>",
"updated_at": "<string>"
}
],
"meta_description": "<string>",
"meta_title": "<string>",
"omnichannel": {
"attributes": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
]
}
],
"categories": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": [
{
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"children": [
{
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"children": "<array>",
"created_at": "<string>",
"id": "<string>",
"name": "<string>",
"parent_id": "<string>",
"redirects": [
{
"id": "<string>",
"item_id": "<string>",
"locale": "<string>",
"new_slug": "<string>",
"old_slug": "<string>",
"type": "product"
}
],
"slug": "<string>",
"sort_order": 123,
"status": "<string>",
"translations": {
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"slug": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"uri": "<string>"
}
],
"created_at": "<string>",
"id": "<string>",
"name": "<string>",
"order": 123,
"parent_id": "<string>",
"redirects": [
{
"id": "<string>",
"item_id": "<string>",
"locale": "<string>",
"new_slug": "<string>",
"old_slug": "<string>",
"type": "product"
}
],
"slug": "<string>",
"sort_order": 123,
"status": "<string>",
"translations": {
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"slug": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"uri": "<string>"
}
]
}
],
"collections": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": [
{
"slug": "<string>",
"status": "active",
"children": [
{
"slug": "<string>",
"status": "active",
"children": "<array>",
"created_at": "<string>",
"id": "<string>",
"parent_id": "<string>",
"redirects": [
{
"id": "<string>",
"item_id": "<string>",
"locale": "<string>",
"new_slug": "<string>",
"old_slug": "<string>",
"type": "product"
}
],
"title": "<string>",
"translations": {
"slug": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"title": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"uri": "<string>"
}
],
"created_at": "<string>",
"id": "<string>",
"order": 123,
"parent_id": "<string>",
"redirects": [
{
"id": "<string>",
"item_id": "<string>",
"locale": "<string>",
"new_slug": "<string>",
"old_slug": "<string>",
"type": "product"
}
],
"title": "<string>",
"translations": {
"slug": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"title": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"uri": "<string>"
}
]
}
],
"description": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"html_description": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"html_short_description": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"images": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": [
{
"alt": "<string>",
"app_id": "<string>",
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"blurhash": "<string>",
"copyright": "<string>",
"custom": {},
"folder_id": "<string>",
"id": "<string>",
"priority": 123,
"status": "<string>",
"title": "<string>",
"translations": {
"alt": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"copyright": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"title": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"url": "<string>"
}
]
}
],
"meta_description": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"meta_title": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"product_name": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"short_description": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"slug": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"tags": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": [
{
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"created_at": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"markets": [
{
"active": true,
"country_codes": [
"<string>"
],
"created_at": "<string>",
"currency_code": "<string>",
"id": "<string>",
"locale": "<string>",
"name": "<string>",
"slug": "<string>",
"updated_at": "<string>"
}
],
"name": "<string>",
"order": 123,
"schedules": [
{
"execute_at": "<string>",
"finished_at": "<string>",
"id": "<string>",
"item_id": "<string>",
"item_type": "<string>",
"to_amount_cents_with_tax": 123,
"to_on_sale": true,
"to_sale_amount_cents_with_tax": 123,
"to_status": "<string>"
}
],
"status": "<string>",
"translations": {
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>"
}
]
}
]
},
"package_dimensions": {
"capacity_milliliter": 1,
"depth": 1,
"diameter": 1,
"height": 1,
"length": 1,
"weight": 1,
"width": 1
},
"product_dimensions": {
"capacity_milliliter": 1,
"depth": 1,
"diameter": 1,
"height": 1,
"length": 1,
"weight": 1,
"width": 1
},
"product_name": "<string>",
"product_number": "<string>",
"redirects": [
{
"id": "<string>",
"item_id": "<string>",
"locale": "<string>",
"new_slug": "<string>",
"old_slug": "<string>",
"type": "product"
}
],
"relations": [
{
"id": "<string>",
"products": [
{
"description": "<string>",
"id": "<string>",
"product_name": "<string>",
"product_number": "<string>",
"slug": "<string>"
}
],
"title": "<string>",
"type": "<string>",
"type_id": "<string>"
}
],
"schedules": [
{
"execute_at": "<string>",
"finished_at": "<string>",
"id": "<string>",
"item_id": "<string>",
"item_type": "<string>",
"to_amount_cents_with_tax": 123,
"to_on_sale": true,
"to_sale_amount_cents_with_tax": 123,
"to_status": "<string>"
}
],
"short_description": "<string>",
"slug": "<string>",
"status": "<string>",
"tags": [
{
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"created_at": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"markets": [
{
"active": true,
"country_codes": [
"<string>"
],
"created_at": "<string>",
"currency_code": "<string>",
"id": "<string>",
"locale": "<string>",
"name": "<string>",
"slug": "<string>",
"updated_at": "<string>"
}
],
"name": "<string>",
"order": 123,
"schedules": [
{
"execute_at": "<string>",
"finished_at": "<string>",
"id": "<string>",
"item_id": "<string>",
"item_type": "<string>",
"to_amount_cents_with_tax": 123,
"to_on_sale": true,
"to_sale_amount_cents_with_tax": 123,
"to_status": "<string>"
}
],
"status": "<string>",
"translations": {
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>"
}
],
"tax_group_id": "<string>",
"third_part_links": [
{
"created_at": "<string>",
"id": "<string>",
"title": "<string>",
"type": "<string>",
"updated_at": "<string>",
"url": "<string>"
}
],
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"html_description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"html_short_description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"meta_description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"meta_title": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"short_description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"slug": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"variants": [
{
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"created_at": "<string>",
"id": "<string>",
"images": [
{
"alt": "<string>",
"app_id": "<string>",
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"blurhash": "<string>",
"copyright": "<string>",
"custom": {},
"folder_id": "<string>",
"id": "<string>",
"priority": 123,
"status": "<string>",
"title": "<string>",
"translations": {
"alt": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"copyright": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"title": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"url": "<string>"
}
],
"listings": {
"smart": [
{
"id": "<string>",
"slug": "<string>"
}
],
"static": [
{
"id": "<string>",
"slug": "<string>"
}
]
},
"omnichannel": {
"store_group_attributes": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
]
}
],
"store_group_categories": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": [
{
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"children": [
{
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"children": "<array>",
"created_at": "<string>",
"id": "<string>",
"name": "<string>",
"parent_id": "<string>",
"redirects": [
{
"id": "<string>",
"item_id": "<string>",
"locale": "<string>",
"new_slug": "<string>",
"old_slug": "<string>",
"type": "product"
}
],
"slug": "<string>",
"sort_order": 123,
"status": "<string>",
"translations": {
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"slug": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"uri": "<string>"
}
],
"created_at": "<string>",
"id": "<string>",
"name": "<string>",
"order": 123,
"parent_id": "<string>",
"redirects": [
{
"id": "<string>",
"item_id": "<string>",
"locale": "<string>",
"new_slug": "<string>",
"old_slug": "<string>",
"type": "product"
}
],
"slug": "<string>",
"sort_order": 123,
"status": "<string>",
"translations": {
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"slug": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"uri": "<string>"
}
]
}
],
"store_group_collections": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": [
{
"slug": "<string>",
"status": "active",
"children": [
{
"slug": "<string>",
"status": "active",
"children": "<array>",
"created_at": "<string>",
"id": "<string>",
"parent_id": "<string>",
"redirects": [
{
"id": "<string>",
"item_id": "<string>",
"locale": "<string>",
"new_slug": "<string>",
"old_slug": "<string>",
"type": "product"
}
],
"title": "<string>",
"translations": {
"slug": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"title": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"uri": "<string>"
}
],
"created_at": "<string>",
"id": "<string>",
"order": 123,
"parent_id": "<string>",
"redirects": [
{
"id": "<string>",
"item_id": "<string>",
"locale": "<string>",
"new_slug": "<string>",
"old_slug": "<string>",
"type": "product"
}
],
"title": "<string>",
"translations": {
"slug": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"title": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"uri": "<string>"
}
]
}
],
"store_group_images": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": [
{
"alt": "<string>",
"app_id": "<string>",
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"blurhash": "<string>",
"copyright": "<string>",
"custom": {},
"folder_id": "<string>",
"id": "<string>",
"priority": 123,
"status": "<string>",
"title": "<string>",
"translations": {
"alt": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"copyright": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"title": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"url": "<string>"
}
]
}
],
"store_group_tags": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": [
{
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"created_at": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"markets": [
{
"active": true,
"country_codes": [
"<string>"
],
"created_at": "<string>",
"currency_code": "<string>",
"id": "<string>",
"locale": "<string>",
"name": "<string>",
"slug": "<string>",
"updated_at": "<string>"
}
],
"name": "<string>",
"order": 123,
"schedules": [
{
"execute_at": "<string>",
"finished_at": "<string>",
"id": "<string>",
"item_id": "<string>",
"item_type": "<string>",
"to_amount_cents_with_tax": 123,
"to_on_sale": true,
"to_sale_amount_cents_with_tax": 123,
"to_status": "<string>"
}
],
"status": "<string>",
"translations": {
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>"
}
]
}
],
"store_group_variant_name": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
]
},
"parent_product_id": "<string>",
"shipping_attributes": [
"<string>"
],
"status": "<string>",
"store_group": [
{
"created_at": "<string>",
"id": "<string>",
"name": "<string>",
"prices": [
{
"amount_cents_with_tax": 123,
"created_at": "<string>",
"id": "<string>",
"market": {
"active": true,
"country_codes": [
"<string>"
],
"created_at": "<string>",
"currency_code": "<string>",
"id": "<string>",
"locale": "<string>",
"name": "<string>",
"slug": "<string>",
"updated_at": "<string>"
},
"on_sale": true,
"sale_end_timestamp": "<string>",
"sale_price_with_tax": 123,
"sale_start_timestamp": "<string>",
"status": "active",
"updated_at": "<string>"
}
],
"slug": "<string>",
"store_type": "<string>",
"updated_at": "<string>"
}
],
"tags": [
{
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"created_at": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"markets": [
{
"active": true,
"country_codes": [
"<string>"
],
"created_at": "<string>",
"currency_code": "<string>",
"id": "<string>",
"locale": "<string>",
"name": "<string>",
"slug": "<string>",
"updated_at": "<string>"
}
],
"name": "<string>",
"schedules": [
{
"execute_at": "<string>",
"finished_at": "<string>",
"id": "<string>",
"item_id": "<string>",
"item_type": "<string>",
"to_amount_cents_with_tax": 123,
"to_on_sale": true,
"to_sale_amount_cents_with_tax": 123,
"to_status": "<string>"
}
],
"status": "<string>",
"translations": {
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>"
}
],
"translations": {
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"validate_stock": true,
"variant_name": "<string>",
"variant_number": "<string>",
"videos": [
{
"description": "<string>",
"folder_id": "<string>",
"id": "<string>",
"path": "<string>",
"status": "<string>",
"title": "<string>",
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"title": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"variants": [
{
"format": "<string>",
"height": 123,
"url": "<string>",
"width": 123
}
]
}
],
"warehouse_variant_stock": [
{
"available_online": true,
"created_at": "<string>",
"id": "<string>",
"inventory_date": "<string>",
"quantity": 123,
"updated_at": "<string>",
"warehouse_name": "<string>",
"warehouse_slug": "<string>"
}
]
}
],
"videos": [
{
"description": "<string>",
"folder_id": "<string>",
"id": "<string>",
"path": "<string>",
"status": "<string>",
"title": "<string>",
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"title": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"variants": [
{
"format": "<string>",
"height": 123,
"url": "<string>",
"width": 123
}
]
}
]
}
],
"success": true,
"total": 123,
"total_pages": 123
}Products
Get Products for the App
Returns a list of products for the application.
GET
/
api
/
v1
/
:team_slug
/
:app_slug
/
products
Error
Copy
A valid request URL is required to generate request examplesCopy
{
"data": [
{
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"brand": {
"id": "<string>",
"name": "<string>",
"series": {
"id": "<string>",
"name": "<string>",
"slug": "<string>"
},
"slug": "<string>"
},
"categories": [
{
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"children": [
{
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"children": "<array>",
"created_at": "<string>",
"id": "<string>",
"name": "<string>",
"parent_id": "<string>",
"redirects": [
{
"id": "<string>",
"item_id": "<string>",
"locale": "<string>",
"new_slug": "<string>",
"old_slug": "<string>",
"type": "product"
}
],
"slug": "<string>",
"sort_order": 123,
"status": "<string>",
"translations": {
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"slug": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"uri": "<string>"
}
],
"created_at": "<string>",
"id": "<string>",
"name": "<string>",
"order": 123,
"parent_id": "<string>",
"redirects": [
{
"id": "<string>",
"item_id": "<string>",
"locale": "<string>",
"new_slug": "<string>",
"old_slug": "<string>",
"type": "product"
}
],
"slug": "<string>",
"sort_order": 123,
"status": "<string>",
"translations": {
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"slug": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"uri": "<string>"
}
],
"collections": [
{
"slug": "<string>",
"status": "active",
"children": [
{
"slug": "<string>",
"status": "active",
"children": "<array>",
"created_at": "<string>",
"id": "<string>",
"parent_id": "<string>",
"redirects": [
{
"id": "<string>",
"item_id": "<string>",
"locale": "<string>",
"new_slug": "<string>",
"old_slug": "<string>",
"type": "product"
}
],
"title": "<string>",
"translations": {
"slug": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"title": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"uri": "<string>"
}
],
"created_at": "<string>",
"id": "<string>",
"order": 123,
"parent_id": "<string>",
"redirects": [
{
"id": "<string>",
"item_id": "<string>",
"locale": "<string>",
"new_slug": "<string>",
"old_slug": "<string>",
"type": "product"
}
],
"title": "<string>",
"translations": {
"slug": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"title": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"uri": "<string>"
}
],
"created_at": "<string>",
"custom": {},
"description": "<string>",
"exclude_from_feeds": true,
"files": [
{
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"created_at": "<string>",
"folder_id": "<string>",
"id": "<string>",
"title": "<string>",
"translations": {
"title": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"type": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"type": "<string>",
"updated_at": "<string>",
"url": "<string>"
}
],
"html_description": "<string>",
"html_short_description": "<string>",
"id": "<string>",
"images": [
{
"alt": "<string>",
"app_id": "<string>",
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"blurhash": "<string>",
"copyright": "<string>",
"custom": {},
"folder_id": "<string>",
"id": "<string>",
"priority": 123,
"status": "<string>",
"title": "<string>",
"translations": {
"alt": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"copyright": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"title": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"url": "<string>"
}
],
"market_status": [
{
"created_at": "<string>",
"market_id": "<string>",
"market_slug": "<string>",
"status": "<string>",
"store_group_id": "<string>",
"store_group_slug": "<string>",
"updated_at": "<string>"
}
],
"markets": [
{
"active": true,
"country_codes": [
"<string>"
],
"created_at": "<string>",
"currency_code": "<string>",
"id": "<string>",
"locale": "<string>",
"name": "<string>",
"slug": "<string>",
"updated_at": "<string>"
}
],
"meta_description": "<string>",
"meta_title": "<string>",
"omnichannel": {
"attributes": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
]
}
],
"categories": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": [
{
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"children": [
{
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"children": "<array>",
"created_at": "<string>",
"id": "<string>",
"name": "<string>",
"parent_id": "<string>",
"redirects": [
{
"id": "<string>",
"item_id": "<string>",
"locale": "<string>",
"new_slug": "<string>",
"old_slug": "<string>",
"type": "product"
}
],
"slug": "<string>",
"sort_order": 123,
"status": "<string>",
"translations": {
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"slug": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"uri": "<string>"
}
],
"created_at": "<string>",
"id": "<string>",
"name": "<string>",
"order": 123,
"parent_id": "<string>",
"redirects": [
{
"id": "<string>",
"item_id": "<string>",
"locale": "<string>",
"new_slug": "<string>",
"old_slug": "<string>",
"type": "product"
}
],
"slug": "<string>",
"sort_order": 123,
"status": "<string>",
"translations": {
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"slug": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"uri": "<string>"
}
]
}
],
"collections": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": [
{
"slug": "<string>",
"status": "active",
"children": [
{
"slug": "<string>",
"status": "active",
"children": "<array>",
"created_at": "<string>",
"id": "<string>",
"parent_id": "<string>",
"redirects": [
{
"id": "<string>",
"item_id": "<string>",
"locale": "<string>",
"new_slug": "<string>",
"old_slug": "<string>",
"type": "product"
}
],
"title": "<string>",
"translations": {
"slug": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"title": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"uri": "<string>"
}
],
"created_at": "<string>",
"id": "<string>",
"order": 123,
"parent_id": "<string>",
"redirects": [
{
"id": "<string>",
"item_id": "<string>",
"locale": "<string>",
"new_slug": "<string>",
"old_slug": "<string>",
"type": "product"
}
],
"title": "<string>",
"translations": {
"slug": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"title": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"uri": "<string>"
}
]
}
],
"description": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"html_description": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"html_short_description": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"images": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": [
{
"alt": "<string>",
"app_id": "<string>",
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"blurhash": "<string>",
"copyright": "<string>",
"custom": {},
"folder_id": "<string>",
"id": "<string>",
"priority": 123,
"status": "<string>",
"title": "<string>",
"translations": {
"alt": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"copyright": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"title": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"url": "<string>"
}
]
}
],
"meta_description": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"meta_title": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"product_name": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"short_description": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"slug": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"tags": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": [
{
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"created_at": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"markets": [
{
"active": true,
"country_codes": [
"<string>"
],
"created_at": "<string>",
"currency_code": "<string>",
"id": "<string>",
"locale": "<string>",
"name": "<string>",
"slug": "<string>",
"updated_at": "<string>"
}
],
"name": "<string>",
"order": 123,
"schedules": [
{
"execute_at": "<string>",
"finished_at": "<string>",
"id": "<string>",
"item_id": "<string>",
"item_type": "<string>",
"to_amount_cents_with_tax": 123,
"to_on_sale": true,
"to_sale_amount_cents_with_tax": 123,
"to_status": "<string>"
}
],
"status": "<string>",
"translations": {
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>"
}
]
}
]
},
"package_dimensions": {
"capacity_milliliter": 1,
"depth": 1,
"diameter": 1,
"height": 1,
"length": 1,
"weight": 1,
"width": 1
},
"product_dimensions": {
"capacity_milliliter": 1,
"depth": 1,
"diameter": 1,
"height": 1,
"length": 1,
"weight": 1,
"width": 1
},
"product_name": "<string>",
"product_number": "<string>",
"redirects": [
{
"id": "<string>",
"item_id": "<string>",
"locale": "<string>",
"new_slug": "<string>",
"old_slug": "<string>",
"type": "product"
}
],
"relations": [
{
"id": "<string>",
"products": [
{
"description": "<string>",
"id": "<string>",
"product_name": "<string>",
"product_number": "<string>",
"slug": "<string>"
}
],
"title": "<string>",
"type": "<string>",
"type_id": "<string>"
}
],
"schedules": [
{
"execute_at": "<string>",
"finished_at": "<string>",
"id": "<string>",
"item_id": "<string>",
"item_type": "<string>",
"to_amount_cents_with_tax": 123,
"to_on_sale": true,
"to_sale_amount_cents_with_tax": 123,
"to_status": "<string>"
}
],
"short_description": "<string>",
"slug": "<string>",
"status": "<string>",
"tags": [
{
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"created_at": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"markets": [
{
"active": true,
"country_codes": [
"<string>"
],
"created_at": "<string>",
"currency_code": "<string>",
"id": "<string>",
"locale": "<string>",
"name": "<string>",
"slug": "<string>",
"updated_at": "<string>"
}
],
"name": "<string>",
"order": 123,
"schedules": [
{
"execute_at": "<string>",
"finished_at": "<string>",
"id": "<string>",
"item_id": "<string>",
"item_type": "<string>",
"to_amount_cents_with_tax": 123,
"to_on_sale": true,
"to_sale_amount_cents_with_tax": 123,
"to_status": "<string>"
}
],
"status": "<string>",
"translations": {
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>"
}
],
"tax_group_id": "<string>",
"third_part_links": [
{
"created_at": "<string>",
"id": "<string>",
"title": "<string>",
"type": "<string>",
"updated_at": "<string>",
"url": "<string>"
}
],
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"html_description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"html_short_description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"meta_description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"meta_title": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"short_description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"slug": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"variants": [
{
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"created_at": "<string>",
"id": "<string>",
"images": [
{
"alt": "<string>",
"app_id": "<string>",
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"blurhash": "<string>",
"copyright": "<string>",
"custom": {},
"folder_id": "<string>",
"id": "<string>",
"priority": 123,
"status": "<string>",
"title": "<string>",
"translations": {
"alt": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"copyright": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"title": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"url": "<string>"
}
],
"listings": {
"smart": [
{
"id": "<string>",
"slug": "<string>"
}
],
"static": [
{
"id": "<string>",
"slug": "<string>"
}
]
},
"omnichannel": {
"store_group_attributes": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
]
}
],
"store_group_categories": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": [
{
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"children": [
{
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"children": "<array>",
"created_at": "<string>",
"id": "<string>",
"name": "<string>",
"parent_id": "<string>",
"redirects": [
{
"id": "<string>",
"item_id": "<string>",
"locale": "<string>",
"new_slug": "<string>",
"old_slug": "<string>",
"type": "product"
}
],
"slug": "<string>",
"sort_order": 123,
"status": "<string>",
"translations": {
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"slug": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"uri": "<string>"
}
],
"created_at": "<string>",
"id": "<string>",
"name": "<string>",
"order": 123,
"parent_id": "<string>",
"redirects": [
{
"id": "<string>",
"item_id": "<string>",
"locale": "<string>",
"new_slug": "<string>",
"old_slug": "<string>",
"type": "product"
}
],
"slug": "<string>",
"sort_order": 123,
"status": "<string>",
"translations": {
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"slug": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"uri": "<string>"
}
]
}
],
"store_group_collections": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": [
{
"slug": "<string>",
"status": "active",
"children": [
{
"slug": "<string>",
"status": "active",
"children": "<array>",
"created_at": "<string>",
"id": "<string>",
"parent_id": "<string>",
"redirects": [
{
"id": "<string>",
"item_id": "<string>",
"locale": "<string>",
"new_slug": "<string>",
"old_slug": "<string>",
"type": "product"
}
],
"title": "<string>",
"translations": {
"slug": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"title": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"uri": "<string>"
}
],
"created_at": "<string>",
"id": "<string>",
"order": 123,
"parent_id": "<string>",
"redirects": [
{
"id": "<string>",
"item_id": "<string>",
"locale": "<string>",
"new_slug": "<string>",
"old_slug": "<string>",
"type": "product"
}
],
"title": "<string>",
"translations": {
"slug": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"title": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"uri": "<string>"
}
]
}
],
"store_group_images": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": [
{
"alt": "<string>",
"app_id": "<string>",
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"blurhash": "<string>",
"copyright": "<string>",
"custom": {},
"folder_id": "<string>",
"id": "<string>",
"priority": 123,
"status": "<string>",
"title": "<string>",
"translations": {
"alt": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"copyright": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"title": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"url": "<string>"
}
]
}
],
"store_group_tags": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": [
{
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"created_at": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"markets": [
{
"active": true,
"country_codes": [
"<string>"
],
"created_at": "<string>",
"currency_code": "<string>",
"id": "<string>",
"locale": "<string>",
"name": "<string>",
"slug": "<string>",
"updated_at": "<string>"
}
],
"name": "<string>",
"order": 123,
"schedules": [
{
"execute_at": "<string>",
"finished_at": "<string>",
"id": "<string>",
"item_id": "<string>",
"item_type": "<string>",
"to_amount_cents_with_tax": 123,
"to_on_sale": true,
"to_sale_amount_cents_with_tax": 123,
"to_status": "<string>"
}
],
"status": "<string>",
"translations": {
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>"
}
]
}
],
"store_group_variant_name": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
]
},
"parent_product_id": "<string>",
"shipping_attributes": [
"<string>"
],
"status": "<string>",
"store_group": [
{
"created_at": "<string>",
"id": "<string>",
"name": "<string>",
"prices": [
{
"amount_cents_with_tax": 123,
"created_at": "<string>",
"id": "<string>",
"market": {
"active": true,
"country_codes": [
"<string>"
],
"created_at": "<string>",
"currency_code": "<string>",
"id": "<string>",
"locale": "<string>",
"name": "<string>",
"slug": "<string>",
"updated_at": "<string>"
},
"on_sale": true,
"sale_end_timestamp": "<string>",
"sale_price_with_tax": 123,
"sale_start_timestamp": "<string>",
"status": "active",
"updated_at": "<string>"
}
],
"slug": "<string>",
"store_type": "<string>",
"updated_at": "<string>"
}
],
"tags": [
{
"attributes": [
{
"created_at": "<string>",
"description": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"name": "<string>",
"template_key": "<string>",
"template_name": "<string>",
"translatable": true,
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"values": {}
}
],
"created_at": "<string>",
"filterable": true,
"id": "<string>",
"key": "<string>",
"markets": [
{
"active": true,
"country_codes": [
"<string>"
],
"created_at": "<string>",
"currency_code": "<string>",
"id": "<string>",
"locale": "<string>",
"name": "<string>",
"slug": "<string>",
"updated_at": "<string>"
}
],
"name": "<string>",
"schedules": [
{
"execute_at": "<string>",
"finished_at": "<string>",
"id": "<string>",
"item_id": "<string>",
"item_type": "<string>",
"to_amount_cents_with_tax": 123,
"to_on_sale": true,
"to_sale_amount_cents_with_tax": 123,
"to_status": "<string>"
}
],
"status": "<string>",
"translations": {
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>"
}
],
"translations": {
"name": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"updated_at": "<string>",
"validate_stock": true,
"variant_name": "<string>",
"variant_number": "<string>",
"videos": [
{
"description": "<string>",
"folder_id": "<string>",
"id": "<string>",
"path": "<string>",
"status": "<string>",
"title": "<string>",
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"title": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"variants": [
{
"format": "<string>",
"height": 123,
"url": "<string>",
"width": 123
}
]
}
],
"warehouse_variant_stock": [
{
"available_online": true,
"created_at": "<string>",
"id": "<string>",
"inventory_date": "<string>",
"quantity": 123,
"updated_at": "<string>",
"warehouse_name": "<string>",
"warehouse_slug": "<string>"
}
]
}
],
"videos": [
{
"description": "<string>",
"folder_id": "<string>",
"id": "<string>",
"path": "<string>",
"status": "<string>",
"title": "<string>",
"translations": {
"description": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
],
"title": [
{
"id": "<string>",
"locale": "<string>",
"omni_channel_translations": [
{
"id": "<string>",
"market_id": "<string>",
"store_group_id": "<string>",
"value": "<string>"
}
],
"value": "<string>"
}
]
},
"variants": [
{
"format": "<string>",
"height": 123,
"url": "<string>",
"width": 123
}
]
}
]
}
],
"success": true,
"total": 123,
"total_pages": 123
}Query Parameters
Page number (default is 1)
Amount of products per page. Minimum 0 and max 100 (default is 20)
Filter by category URI
Filter by collection URI
Filter by attributes. The format should be template_key/attribute_key. e.g colors/black
Filter by brand name
Filter by market slugs (commercial availability - products with variant prices in these markets)
Search on product name
Search by status, active | inactive | draft | incomplete
Sort order. Should be one of ASC or DESC. Default DESC
The key to sort on. Can be one of product-name, product-number, created-at, updated-at, status, category, tag, collection. (Default is created_at). When sorting by category, tag, or collection order, you must also filter by a single corresponding item.
Filter by tag keys
Only show products which don't follow the publishing rules for the specific app
ISO 8601 date. Fetch products created before this date.
ISO 8601 date. Fetch products created after this date.
ISO 8601 date. Fetch products updated before this date.
ISO 8601 date. Fetch products updated after this date.
Filter by whether product description exists.
Filter by substring in description.
Filter by whether any product translations exist.
Filter by whether any product relation exist.
Filter on a specific product relation type
Filter by marketing status (active, inactive, draft, incomplete, archived). Can be combined with product-market-status-market and/or product-market-status-store-group
Filter products by marketing status in specific market(s). Requires product-market-status to be specified
Filter products by marketing status in specific store group/channel. Requires product-market-status to be specified
Filter products that have no categories
Filter products that have no variants
⌘I