Products
List products
Newest first. Pass updated_since to get every product changed since a moment, oldest change first — a variant's stock or price change counts as a change to its product.
Query parameters
- limitinteger
How many objects to return, 1–100. Default 25.
1–100
- cursorstring
The
next_cursorfrom the previous page. Repeat the same filters with it.up to 512 characters
- updated_sincestring
Only objects changed at or after this moment (ISO-8601). Switches the order to oldest change first, so you can store the last
updated_atyou saw and resume from it. Objects changed in the same second may be returned again — de-duplicate byid.ISO 8601 date-time, UTC
- created_sincestring
Only objects created at or after this moment (ISO-8601).
ISO 8601 date-time, UTC
- statusstring
One of
draft,published,archived - qstring
Text the product title contains.
2–100 characters
- skustring
Exact SKU of one of the product's variants (case-insensitive).
1–100 characters
- handlestring
The product's handle, the last part of its storefront address (
/products/oversized-hoodie). Case-insensitive.1–200 characters
Returns
200 OK · A page of products. ProductList
- objectstringRequired
always "list"
- has_morebooleanRequired
- next_cursorstring or nullRequired
Pass as
cursorto get the next page.nullon the last page. - dataarray of ProductsRequired
18 child fields
- idstringRequired
starts with prod_
- objectstringRequired
always "product"
- titlestringRequired
- handlestringRequired
The product's address in the storefront.
- description_htmlstring or null
- statusstringRequired
One of
draft,published,archived - product_typestring or null
- vendorstring or null
- categorystring or null
- tagsarray of strings
- weight_gramsinteger or null
- optionsarray of objectsRequired
3 child fields
- namestring
- typestring
How the option is shown, e.g. color, size or text.
- valuesarray of strings
- variantsarray of VariantsRequired
21 child fields
- idstringRequired
starts with var_
- objectstringRequired
always "variant"
- product_idstringRequired
- titlestringRequired
The option values joined, e.g. "Black / M". "Default" for a product without options.
- optionsobjectRequired
Option name → value.
- skustring or null
- barcodestring or null
- priceMoneyRequired
An amount of money.
amountis a decimal STRING with exactly the currency's number of decimals ("1250.00" in DZD, "12.500" in TND) — never parse it into a float.2 child fields
- amountstringRequired
- currencystringRequired
- compare_at_priceMoney or null
2 child fields
- amountstringRequired
- currencystringRequired
- costMoney or null
Only present when the key has the
products:read_costsscope.2 child fields
- amountstringRequired
- currencystringRequired
- inventory_quantityintegerRequired
Units in stock. Negative when units are owed to pre-orders.
- inventory_trackedboolean
- incoming_quantityinteger
Units on their way from a supplier.
- incoming_due_atstring or null
When the incoming delivery is expected.
ISO 8601 date-time, UTC
- allow_preorderboolean
Orderable past zero
- allow_backorderboolean
Orderable past zero without limit; the merchant owes the units.
- at_courierinteger
Units kept at the courier's warehouse.
- image_urlstring or null
- livemodebooleanRequired
- created_atstringRequired
ISO 8601 date-time, UTC
- updated_atstringRequired
ISO 8601 date-time, UTC
- imagesarray of objectsRequired
4 child fields
- idstring
starts with img_
- urlstring
- altstring or null
- positioninteger
- urlstring or null
The product's page in the storefront. Null while it isn't published, and in test mode.
- livemodebooleanRequired
- created_atstringRequired
ISO 8601 date-time, UTC
- updated_atstringRequired
Also moves when a variant's stock or price changes.
ISO 8601 date-time, UTC
Errors
Every error has the same shape. This endpoint can answer with:
