Download Sales Orders Export
GET/api/sales-orders/list/export/download
Downloads a completed background export produced by Export Sales Orders (queued path). The filename is the one reported in the tracked job log's results.file field.
orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token. Scope: orders (read).
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: sales_orders.export
file must be a file name produced by this endpoint's export. Any other name, or a name containing a path, returns 404.
Only the user who started the export, or an account admin, can download it; anyone else gets the same 404 as a missing file.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
Not Found
Response Headers
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.