Sync Order Detail
POST/api/starshipit/integration-instances/:integration_instance/orders/:order/sync-detail
Fetches the latest data for a single order live from the StarShipIt API and persists it to the local cache (updating json_object, setting has_detailed_data and details_last_updated). Returns the refreshed order, including the raw payload.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
This is the live-refresh companion to GET .../orders/:order/detail, which reads the cache without calling StarShipIt.
If the order has no StarShipIt order ID yet (for example a deferred submission placeholder), the order is returned unchanged. Returns 404 when the order does not belong to this instance, and 502 when the StarShipIt API call fails.
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
- 502
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 — 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.
Bad Gateway