Complete SPS Commerce Integration Setup
POST/api/spscommerce/integrations/complete
Finish connecting after the SPS Commerce consent screen redirected back: exchanges the authorization code, stores the token, creates the connection and its sales channel.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token and the integrations.update permission.
Body: state (required, from Initialize), receiver_id (required, your SPS trading-partner ID), sender_id (optional), name (optional), is_auto_polling_enabled (optional, default false).
Returns 422 when receiver_id is missing; 400 when the state was not issued to this account or has expired.
Request
Responses
- 200
- 401
- 403
- 422
- 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.
Unprocessable Content
Response Headers
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.