v5

latestOpenAPI 3.0.02026-08-017841,2603.2 MB
commerce
item

List all items

get/commerce/{connection_id}/item

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

collection_idstring

The collection ID to filter by (reference to CommerceCollection)

org_idstring

The org ID to filter by (reference to AccountingOrganization)

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time
updated_atstring date-time
namestring
public_namestring
slugstring
descriptionstring
global_codestring
public_descriptionstring
is_activeboolean
is_taxableboolean
vendor_namestring
typestring
is_visibleboolean
is_featuredboolean
weightnumber
weight_unit'g' | 'kg' | 'oz' | 'lb'
requires_shippingboolean
inventory_idstring
total_stocknumber
tagsstring[]
collection_idsstring[]

@deprecated; use collections instead

account_idstring
taxrate_idstring
location_idstring
durationnumber
rawobject