Test Connection
POST/api/shippo/test
Checks a Shippo API token live against Shippo before it is saved. Nothing is persisted. Use it to validate a token before creating the integration instance.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Body fields:
- api_token (string, required): the Shippo API token. 20–255 characters, must start with shippo_test_ (test mode) or shippo_live_ (live mode). Surrounding whitespace is trimmed.
Returns 200 with connected: true and is_test_mode (derived from the token prefix). Shippo failures return 422 with a stable code: invalid_token (Shippo rejected the API token), rate_limited (Shippo is throttling — retry in a minute), api_error (Shippo refused the request; message carries its reason) or unreachable (Shippo could not be reached). Returns 422 with field errors when validation fails.
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.