Test Connection
POST/api/starshipit/integration-instances/:integration_instance/test-connection
Verifies the stored StarShipIt credentials by making a live call to the StarShipIt API (it fetches a single unshipped order). No request body.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Returns 200 with a success message when StarShipIt accepts the credentials, or 400 when the call fails (bad API key / subscription key, network failure).
Authentication: Requires Bearer token.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Bad Request
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.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
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.