Itemvariant data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
name | string | No | |
public_name | string | No | |
description | string | No | |
public_description | string | No | |
sku | string | No | barcode, UPC, isbn, etc |
is_active | boolean | No | |
is_visible | boolean | No | |
is_featured | boolean | No | |
media | CommerceItemMedia[] | No | |
media[].id | string | No | |
media[].url | string | Yes | |
media[].alt | string | No | |
media[].type | enum | No | Values: image, video |
media[].height | number | No | |
media[].width | number | No | |
media[].position | number | No | 1 is the first |
media[].metadata | CommerceMetadata[] | No | |
media[].metadata[].id | string | No | |
media[].metadata[].value | object | No | |
media[].metadata[].namespace | string | No | |
media[].metadata[].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
media[].metadata[].extra_data | object | No | |
media[].metadata[].slug | string | No | |
media[].metadata[].description | string | No | |
media[].metadata[].is_required | boolean | No | |
available_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
tags | string[] | No | |
width | number | No | |
height | number | No | |
length | number | No | |
weight | number | No | |
size_unit | enum | No | Values: cm, inch |
weight_unit | enum | No | Values: g, kg, oz, lb |
total_stock | number | No | |
prices | CommerceItemPrice[] | No | |
prices[].price | number | Yes | |
prices[].compare_at_price | number | No | The original price of the item before an adjustment or a sale. |
prices[].currency | string | No | |
options | CommerceItemOption[] | No | |
options[].id | string | No | |
options[].name | string | Yes | |
options[].position | number | No | |
options[].values | string[] | Yes | |
inventory_id | string | No | |
requires_shipping | boolean | No | |
metadata | CommerceMetadata[] | No | |
metadata[].id | string | No | |
metadata[].value | object | No | |
metadata[].namespace | string | No | |
metadata[].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No | |
metadata[].slug | string | No | |
metadata[].description | string | No | |
metadata[].is_required | boolean | No | |
items | CommerceReference[] | No | references CommerceItem |
items[].id | string | No | |
items[].name | string | No | |
items[].type | string | No |
Are we missing anything? Let us know