Search Orders (Live)
POST/api/shipstation/integration-instances/:integration_instance/orders/search
Search ShipStation live for orders matching a phrase, for the refresh modal's "Search Specific Order" tab. ShipStation's V1 orderNumber filter is a starts-with match, so the query should be an order number or its prefix (up to 50 results are fetched). 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).
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Body parameters:
query— required string (max 255). The order number (or prefix) to search for.
Errors:
- 422 if
queryis missing or exceeds 255 chars - 502 if the upstream ShipStation call fails (message:
Search failed: ...)
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.
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.