List Purchase Orders
GET/api/spscommerce/:integrationInstance/purchase-orders
List EDI 850 purchase orders received for an SPS Commerce integration, paginated.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token.
Filters: filter[search] (PO number or buyer name, partial), filter[processing_status] (exact), filter[sales_order_id] (exact). Allowed sorts: id, po_number, po_date, buyer_name, total_amount, processing_status, created_at (default -id). Pagination: page, per_page (default 10).
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.