Skip to main content

Download Stock Take Template

GET 
/api/stock-takes/template

Download a ready-to-fill stock-take CSV. It lists one row per countable product (active standard and kit products, or the stock take's own lines when it already has some) with the columns SKU, Name, Warehouse, Qty Counted (Adjustment for an adjustment-mode stock take), Unit Cost and Count As Of.

Required scope: inventory:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Count As Of states the moment the quantities must reflect, on every row: the stock take's count date, or for an opening count that has not been created yet, the inventory start date (written as "End of day 2026-10-31 (start of 2026-11-01)"). Fill in Qty Counted and Unit Cost (average cost per unit; leave blank to use the product's cost), then upload the file to the stock take's item import. Name, Warehouse and Count As Of are for reference and are ignored on upload.

Pass stock_take_id for an existing stock take, or warehouse_id for an opening count. With neither, the Warehouse column is blank.

Response: a CSV file download (text/csv).

Authentication: Requires Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type
    Content-Disposition