Test Saved Shiptheory Connection
POST/api/shiptheory/:integration_instance/test-connection
Validates the credentials stored on a saved Shiptheory instance (no body) and records the outcome so the connection panel reflects it.
integrations:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Path parameter:
- integration_instance: the numeric id of the Shiptheory integration instance.
Authentication: requires a Bearer token.
Returns 200 with { data: { connected: true } } when the stored credentials work, or 422 with a code (invalid_credentials, rate_limited, api_error) and message when they do not.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
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.