Refresh Single Order (Download)
POST/api/starshipit/integration-instances/:integration_instance/orders/refresh-order
Download (or update) a single order live from StarShipIt by its StarShipIt order id and persist it to the local cache. Backs the search tab's per-result Download / Update buttons.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Body parameters:
uniqueId— required string. The StarShipIt order id (thestarshipit_order_idreturned by Search Orders).
Fetches the order via StarShipIt's GET /orders?order_id=, upserts it (with detailed fields), and returns the refreshed order resource (with json_object included).
Errors:
- 422 if
uniqueIdis missing - 502 if the upstream StarShipIt call fails or the order cannot be persisted
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.
Unprocessable Entity
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.
Bad Gateway