Test Shiptheory Connection
POST/api/shiptheory/test-connection
Validates a Shiptheory account email + password without saving a connection. The credentials are exchanged for a short-lived Shiptheory token and a delivery-services probe is run, so you can confirm the login is correct before creating an instance.
integrations:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Body fields:
- email (string, required): the Shiptheory account email. Max 255 characters.
- password (string, required): the Shiptheory account password. Max 255 characters.
Returns 200 with { data: { connected: true } } when the credentials are accepted. Returns 422 with a "code" (invalid_credentials, rate_limited, or api_error) and a user-facing message when Shiptheory rejects the login or cannot be reached, or field errors when the body itself is invalid.
Authentication: requires a Bearer token.
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 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.