Management API
- GETFetch all product variants
- POSTCreate variant
- GETFetch variant
- DELDeletes a variant from a product
- PATCHUpdate variant
- GETGet Product variants StoreGroup
- PUTCreate or update product variant price
- PUTBatch create or update product variant price
- GETGet all prices in a storegroup
- DELDelete price
- PUTUpdate shipping attributes for a variant
- PUTCreate or update warehouse variant stock
- DELDelete warehouse stock
- POSTAdd diff to warehouse stock
- PUTAdd tag to variant
- DELRemove tag from variant
- GETFetch all variants for an app
- POSTBulk create variants
- DELBulk delete variants
- PATCHBulk update variants
- PUTBulk create or update prices
- DELBulk delete prices
- PATCHBulk update prices
- PUTBulk set variant stock
- DELBulk delete variant stock
- 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": {}
}
],
"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>"
}
]
},
"details": [
"<string>"
],
"success": true
}Variants
Add tag to variant
Adds a tag to a variant
PUT
/
api
/
v1
/
:team_slug
/
:app_slug
/
products
/
:product_id
/
variants
/
:variant_id
/
tags
/
:tag_key
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": {}
}
],
"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>"
}
]
},
"details": [
"<string>"
],
"success": true
}Path Parameters
Product ID
Variant ID
App slug
Team slug
Tag key
Response
Updated variant
Show child attributes
Show child attributes
Other information which can be relative to the response. This field is used to give additional information then the main data we want to return. For instance if a product do not match the publishing rules will the product status be set to Incomplete and this field will include why
⌘I