Export Product Inventory Tally
GET/api/v2/products/:product/inventory-tally/export
Exports the product's inventory tally ledger for a warehouse as an XLSX or CSV file, mirroring the on-screen Movement Ledger: chronological rows with Date, Type, Reference, Qty In, Qty Out, and running Balance.
products:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
When channel-debt events exist (units the sales channel fulfilled with no stock, so no movement exists), two extra columns are appended: Channel Debt (the debt quantity, kept separate so Qty In minus Qty Out still reconciles to the closing balance) and Implied Physical Balance (ledger balance minus cumulative channel debt).
Authentication: Requires Bearer token.
Response: File download (binary), not JSON.
Requires permission: inventory.export
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.