List EDI Documents
GET/api/spscommerce/:integrationInstance/documents
Paginated list of every EDI document the connection received or sent, newest first. Each row names the purchase order it belongs to, its sales order and shipment (when it has one), the trading partner, its send status and the reason it failed.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token.
Filters: filter[search], filter_groups (see query params). Sorts: id, transaction_set, direction, status, control_number, partner_reference, created_at, sent_at, received_at (default -id). Pagination: page, per_page (default 10, max 100).
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.