Test SPS Commerce Connection

GET 
/api/spscommerce/integrations/:id/test-connection

Test the connection to SPS Commerce Transaction API.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

This endpoint will use the stored OAuth tokens to make a test API call to SPS Commerce and verify the connection is working.

No Request Body Required

Response:

• success - Connection test result
• message - Status message
• data.success - Whether connection was successful
• data.message - Detailed status message

Request

Responses

200

Successful response

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

404

Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

429

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.