Download Inventory Movements Export

GET 
/api/v2/inventory-movements/list/export/download

Downloads a completed background export produced by Export Inventory Movements (queued path). The filename is the one reported in the tracked job log's results.file field.

Required scope: inventory:read

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

Authentication: Requires Bearer token.

Response is the binary file (CSV or XLSX) with an attachment Content-Disposition header. Returns 404 if the file param is empty or the file no longer exists.

Requires permission: inventory.export

Request

Responses

200

OK

Response Headers

Content-Type
Content-Disposition

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.

404

Not Found

Response Headers

Content-Type

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.