Get Order Detail
GET/api/starshipit/integration-instances/:integration_instance/orders/:order/detail
Returns the locally cached raw StarShipIt payload for a single order.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Response fields:
json_object— the raw order payload as last received from StarShipIt (items, packages, destination, tracking events, writeback status, etc.).has_detailed_data— whether a full per-order detail fetch has ever been performed. List syncs store a summary payload; the detail fetch enriches it.details_last_updated— when the detail payload was last refreshed from StarShipIt (null when never).
This endpoint reads only the local cache and never calls StarShipIt. To refresh the payload live from StarShipIt, use the companion POST .../orders/:order/sync-detail endpoint.
Returns 404 when the order does not belong to this instance.
Authentication: Requires 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.