Test Connection
POST/api/shipbob/test-connection
Validate an unsaved set of ShipBob credentials before creating an instance. Never returns an error status for bad credentials — a failure is reported as connected=false with a message. On success it returns the channels available to the token.
Authentication: Requires Bearer token.
Request Body:
- environment (string, required) — 'production' or 'sandbox'.
- api_token (string, required) — ShipBob Personal Access 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.