Search Orders
POST/api/starshipit/integration-instances/:integration_instance/orders/search
Search StarShipIt live for orders matching a phrase, for the refresh modal's "Search Specific Order" tab. StarShipIt's /orders/search matches across order number, reference, recipient, and the internal order id, so a single phrase covers every identifier a user might paste in. Each result is flagged with whether it already exists in this instance's local cache so the UI can offer Download (new) vs Update (existing).
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Body parameters:
query— required string (max 255). The order number, reference, recipient, or StarShipIt order id to search for.
Errors:
- 422 if
queryis missing - 502 if the upstream StarShipIt 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.
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