Inventory
List inventory levels
The Inventory page as a list: one level per variant of every product that isn't archived, with what is available, committed to orders, incoming, held by the courier, sold in the last 30 days and how many days of stock that leaves.
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
- filterstring
low (at or under the alert level), out (none left), untracked, reorder (runs out within the reorder window), courier (some held by the courier), incoming (a delivery on its way).
One of
all,low,out,untracked,reorder,courier,incoming - searchstring
Matches the product title, SKU, barcode or option values.
1–100 characters
- sortstring
name (A to Z, the default), runway (fewest days of stock first) or newest (newest products first).
One of
name,runway,newest
Returns
200 OK · A page of inventory levels. InventoryLevelList
- objectstringRequired
always "list"
- has_morebooleanRequired
- next_cursorstring or nullRequired
Pass as
cursorto get the next page.nullon the last page. - dataarray of InventoryLevelsRequired
21 child fields
- objectstring
always "inventory_level"
- variant_idstring
starts with var_
- product_idstring
starts with prod_
- product_titlestring
- variant_titlestring or null
- skustring or null
- barcodestring or null
- trackedboolean
Whether the store counts this variant's stock. Untracked variants are always orderable.
- availableinteger
What can still be ordered. Negative when pre-orders or back-orders took more than the shelf holds.
- committedinteger
Units taken by orders not yet with a courier.
- on_handinteger
available + committed: what should physically be in the store.
- incominginteger
Units of a delivery on its way.
- incoming_due_atstring or null
ISO 8601 date-time, UTC
- at_courierinteger
Units the merchant keeps at the courier's warehouse.
- on_shelfinteger
Available units in the merchant's own place.
- low_stockboolean
At or under the store's alert level.
- allow_backorderboolean
- allow_preorderboolean
- sold_30dinteger
Units sold in the last 30 days.
- days_of_covernumber or null
How many days the stock lasts at the 30-day pace. null when nothing sold.
- livemodeboolean
Errors
Every error has the same shape. This endpoint can answer with:
