Refresh Single Order
POST/api/shipstation/integration-instances/:integration_instance/orders/refresh-order
Download (or update) a single order live from ShipStation by its ShipStation order id and upsert it into the local cache with detailed data (has_detailed_data: true, details_last_updated stamped). Backs the search tab's per-result Download/Update buttons. Newly downloaded orders are auto-linked to a matching SKU fulfillment when an unambiguous match exists.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Body parameters:
uniqueId— required string. The ShipStation order id (shipstation_order_id/orderId, as returned by the live search endpoint).
Returns the persisted order serialized with json_object included.
Errors:
- 422 if
uniqueIdis missing - 502 if the upstream ShipStation fetch or persistence fails (message:
Failed to refresh order: ...)
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 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 — 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.