Stock snapshot (JSON, CSV, or Excel)
Point-in-time stock snapshot with optional product filters.
Product filters use the shared bracket-operator syntax, for example
sku[in]=SKU-1,SKU-2, id[in]=1,2, name[contains]=shirt, or
sku_prefix=STYLE-RED-. These let integrations pull a targeted snapshot
without paginating an entire warehouse.
JSON responses are paginated with page and per_page. When export=csv
or export=excel is supplied, pagination is ignored and the filtered
result set is streamed back as a file download.
Returns 202 Accepted with Retry-After when snapshot data is still being prepared.
Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Query Parameters
Start date in Y-m-d H:i:s format
"2025-01-01 00:00:00"
End date in Y-m-d H:i:s format, must be >= start_date
"2025-01-31 23:59:59"
Optional warehouse scope. Products with no stock in that warehouse are excluded.
Filter by product SKU. Supports bracket operators such as sku[eq]=ABC and comma-separated sku[in]=ABC,DEF.
Internal SKU starts-with filter, for example sku_prefix=STYLE-RED-. Useful for pulling a style/size family without substring matches.
Filter by product ID. Supports bracket operators such as id[in]=1,2,3.
Filter by product name. Supports bracket operators such as name[contains]=shirt.
Filter by product category ID.
Filter by product subcategory ID.
Number of items per page (max 100)
x <= 100Page number for pagination
x >= 1Which date the received quantities and values are bucketed by: the purchase order's order_date (default) or the receiving report's received_date.
order_date, received_date When set to excel or csv, returns a file download instead of JSON.
excel, csv JSON string of export column configuration (when exporting).