Test Connection
POST/api/shipstation/integration-instances/:integration_instance/test-connection
Tests the ShipStation API connection for an integration instance by calling the ShipStation V1 List Warehouses endpoint with the instance's stored apiKey/apiSecret.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
No request body. Returns 200 with Connection successful when ShipStation responds successfully, or 400 when the request fails (invalid credentials, network error, etc.).
Authentication: Requires Bearer token.
Requires the integrations.sync permission.
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
Response Headers
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.