Skip to main content

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.

Required scope: integrations:read

Grant 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​

OK

Response Headers
    Content-Type