Get Integration Instance
GET/api/shippit/instances/:integration_instance
Returns a single Shippit integration instance together with a live dashboard summary: the resolved Shippit merchant profile, per-state order counts, total order/courier/warehouse-mapping counts, the webhook URL, and the last webhook and sync timestamps.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Path parameter:
- instance: the numeric ID of the Shippit integration instance.
Returns 404 when the instance does not exist.
Authentication: Requires a Bearer token.
Requires the integrations.show permission.
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
Response Headers
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.