Skip to main content

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.

Required scope: integrations:read

Grant 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​

OK

Response Headers
    Content-Type