Item 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 | |
slug | string | No | |
description | string | No | |
global_code | string | No | |
public_description | string | No | |
is_active | boolean | No | |
is_taxable | boolean | No | |
vendor_name | string | No | |
type | string | No | product, service, digital-download, ... |
is_visible | boolean | No | |
is_featured | boolean | No | |
weight | number | No | |
weight_unit | enum | No | Values: g, kg, oz, lb |
requires_shipping | boolean | 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 | |
inventory_id | string | No | |
total_stock | number | No | |
tags | string[] | 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 | |
account_id | string | No | Reference to Accounting Account (reference to AccountingAccount) |
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 | |
collections | CommerceReference[] | No | points to Collection with id, name, and type fields |
collections[].id | string | No | |
collections[].name | string | No | |
collections[].type | string | No | |
taxrate_id | string | No | references AccountingTaxrate |
location_id | string | No | (reference to CommerceLocation) |
duration | number | No | minutes |
Are we missing anything? Let us know