Export Orders
GET/api/amazon/:integrationInstance/orders/export
Export this integration instance's Amazon orders to a file. Streams a CSV download by default (Content-Type: text/csv); pass format=xlsx for an Excel file.
Filtering, searching, sorting and column selection mirror the orders list endpoint: filters is a JSON string ({"conjunction":"and|or","filterSet":[{"column","operator","value"}]}), query is a general text search, sortObjs is a JSON array of {"column","ascending"} objects, and included/excluded are JSON arrays of column names (mutually exclusive; sending both returns 400).
Pass total=1 to skip file generation and get the export size (rows x columns) back as JSON. Exports of up to 20,000 data points are generated synchronously and downloaded in the response; anything larger queues a background export job and the finished file is emailed to the requesting user (the request returns a redirect). Exporting an empty result set returns a JSON message instead of a 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 — 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.