Export EDI Documents
GET/api/spscommerce/:integrationInstance/documents/export
Download the connection's EDI document list as CSV or XLSX. The file starts with a row number and the document ID, then the chosen columns; date-times are in the account's time zone.
integrations:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
scope picks the rows: filtered (default), all, current_page or selected (with ids). Every filter and sort of List EDI Documents applies.
included: JSON array of column keys to include, in order. Available: id, transaction_set, direction, po_number, control_number, sales_order, fulfillment, sales_invoice, trading_partner_id, status, error, received_at, sent_at, created_at. Leave it out for every column.
Response: a file download, or 202 with a tracked job id for more than 1,000 rows.
Request
Responses
- 200
- 202
- 401
- 403
- 404
- 429
OK
Response Headers
Accepted
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.