Stock
List stock movements
Credential: a company's API key or OAuth token.
The append-only movement ledger, newest first. Every change to on-hand appears here exactly once, so a consumer can reconcile its own view against it.
Required Scope
stock-read
query Parameters
pageDeprecated: page with cursor instead. Page number (1-indexed). From 2026-12-31, a page past the first of a list with more than 10,000 matching rows is refused.
limitcursorOpaque cursor from the previous response's nextCursor. Returns the rows after it, in the same order. Send the same filters and sort as the request that produced it, and do not send page. The preferred way to page through a list.
productIdwarehouseIdList stock movements › Responses
totallimitnextCursorCursor for the next page; pass it as cursor. null on the last page, and on every page of a sort that cannot page by cursor — hasMore then says whether another page follows by page number.
hasMoreWhether more rows follow this page.
pageDeprecated: page with nextCursor instead. Current page number.
List on-hand stock
Credential: a company's API key or OAuth token.
Lists on-hand quantities, one row per position — product × warehouse × location
× quality status. Narrow with ?warehouseId= or ?productId=.
Required Scope
stock-read
query Parameters
pageDeprecated: page with cursor instead. Page number (1-indexed). From 2026-12-31, a page past the first of a list with more than 10,000 matching rows is refused.
limitcursorOpaque cursor from the previous response's nextCursor. Returns the rows after it, in the same order. Send the same filters and sort as the request that produced it, and do not send page. The preferred way to page through a list.
warehouseIdNarrow to one warehouse.
productIdNarrow to one product.
List on-hand stock › Responses
totallimitnextCursorCursor for the next page; pass it as cursor. null on the last page, and on every page of a sort that cannot page by cursor — hasMore then says whether another page follows by page number.
hasMoreWhether more rows follow this page.
pageDeprecated: page with nextCursor instead. Current page number.
On-hand for one product
Credential: a company's API key or OAuth token.
Every position holding this product, across warehouses and quality statuses. Paged like the list route — a product spread over many bins runs past one page.
Required Scope
stock-read
path Parameters
productIdProduct ID
query Parameters
pageDeprecated: page with cursor instead. Page number (1-indexed). From 2026-12-31, a page past the first of a list with more than 10,000 matching rows is refused.
limitcursorOpaque cursor from the previous response's nextCursor. Returns the rows after it, in the same order. Send the same filters and sort as the request that produced it, and do not send page. The preferred way to page through a list.
On-hand for one product › Responses
totallimitnextCursorCursor for the next page; pass it as cursor. null on the last page, and on every page of a sort that cannot page by cursor — hasMore then says whether another page follows by page number.
hasMoreWhether more rows follow this page.
pageDeprecated: page with nextCursor instead. Current page number.