Export Inventory COGS Report
GET/api/reporting/inventory-cogs/export
Streams the flattened Inventory COGS report as a CSV file (inventory-cogs.csv): one row per deepest group, prefixed with the active group-by dimension columns, followed by Avg Cost, Qty Sold, Qty Returned, Qty Adjusted, Net Qty, Gross COGS, Returned COGS, Adjusted COGS, and Net COGS.
reports:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
The response is a file download (text/csv), not JSON.
Authentication: Requires Bearer token. Scope: reports.
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
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.
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.