Item data model

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

Data Model

idstring
created_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestring
public_namestring
slugstring
descriptionstring
global_codestring
public_descriptionstring
is_activeboolean
is_taxableboolean
vendor_namestring
typestring
product, service, digital-download, ...
is_visibleboolean
is_featuredboolean
weightnumber
weight_unit enum
Valid values:
"g"
"kg"
"oz"
"lb"
requires_shippingboolean
prices array
inventory_idstring
total_stocknumber
variants array
first variant is the default variant
tagsstring array
media array
collection_idsstring array
@deprecated; use collections instead
account_idstring
Reference to Accounting Account (reference to AccountingAccount)
metadata array
collections array
points to Collection with id, name, and type fields
taxrate_idstring
references AccountingTaxrate
location_idstring
(reference to CommerceLocation)
durationnumber
minutes
Are we missing anything? Let us know
Was this page helpful?