Get Setup Readiness
GET/api/shiprush/instances/:integration_instance/readiness
Returns the checklist of steps a ShipRush instance needs before it can fulfill orders.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Path parameter:
- instance: the numeric ID of the ShipRush integration instance.
The response "data" object contains:
- ready: true once every required step is complete.
- items: one entry per step with key (warehouse, connection, shipping_methods), label, description, required, complete, action_label and action_route.
Required steps: at least one warehouse routed to the instance, and ShipRush has polled the order feed at least once. Mapping carrier services is recommended but never blocks fulfillment.
Returns 404 when the instance does not exist.
Authentication: Requires a Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
Not Found
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.