Inventory
Retrieve a stock count
GEThttps://api.ordexs.com/v1/stock_counts/{stock_count_id}
The sheet and a page of its lines, in variant id order. Pass the last line's variant_id as lines_after for the next page.
Path parameters
- stock_count_idstringRequired
starts with cnt_
Query parameters
- lines_afterstring
starts with var_
- lines_limitinteger
Lines per page, 1 to 500. Default 100.
1–500
Returns
200 OK · The count sheet. StockCount
- idstring
starts with cnt_
- objectstring
always "stock_count"
- namestring or null
- statusstring
One of
open,applied,discarded - notestring or null
- lines_totalinteger
- lines_countedinteger
- created_atstring
ISO 8601 date-time, UTC
- applied_atstring or null
ISO 8601 date-time, UTC
- livemodeboolean
- linesarray of StockCountLines
A page of lines (single-count answers only).
9 child fields
- variant_idstring
- product_titlestring
- variant_titlestring or null
- skustring or null
- barcodestring or null
- expectedinteger
Stock when the sheet was opened.
- countedinteger or null
What was counted. null until someone counts it.
- currentinteger
Stock right now (sales keep happening while you count).
- varianceinteger or null
counted - current: what applying will change.
- lines_has_moreboolean
- adjusted_variantsinteger
On apply
- adjusted_unitsinteger
On apply
Errors
Every error has the same shape. This endpoint can answer with:
