Export Inventory Valuation

GET 
/api/reporting/inventory-valuation/export

Streams the inventory valuation report as a CSV file download (Content-Type text/csv, attachment inventory-valuation.csv).

Required scope: reports:read

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

Authentication: Requires Bearer token

Columns: the selected group_by dimensions (SKU, Warehouse, Supplier, Brand, COGS Nominal Code) followed by quantity/valuation pairs — Available, Allocated, On Hold, On Hand, On Hand Average Cost, In Transit, Inbound, Prepaid, and Average Cost. On Hand / On Hand Valuation are the physical on-hand position as of the report date (on_hand_active_qty x average cost) and include allocated & on-hold stock but exclude In Transit.

Response: CSV file download (not JSON).

Request

Responses

200

Successful response

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

429

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.