Search Orders
GET/api/shipbob/:instance/orders/search
Live provider-side order search for the refresh/search modal: matches query as a ShipBob reference id first, then as an order number. Returns the raw ShipBob order rows (empty array when nothing matches), each with exists_in_database — true when SKU.io already holds that ShipBob order, so the search dialog offers Update instead of Download.
integrations:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Query parameters:
- query (string, required) — the reference id or order number.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
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.