Test Connection
POST/api/shippit/test
Validates a Shippit API key without saving a connection. Shippit is a courier aggregator; this probes the supplied key against Shippit's merchant endpoint and returns the merchant profile it resolves to, so you can confirm the key is correct before creating an instance.
Body fields:
- api_key (string, required): the Shippit API key to validate. Minimum 8 characters.
- environment (string, optional): which Shippit environment the key belongs to, either "production" or "sandbox". Defaults to "production".
Returns 200 with the resolved merchant name and company/contact details when the key is accepted. Returns 422 with a "code" of "invalid_key" when Shippit rejects the key, or "api_error" when Shippit could not be reached. Returns 422 with field errors when the request 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.