Search orders
starshipit_search_ordersRead-only
Search orders by order number, tracking number, customer reference or recipient name (phrase), optionally limited to unshipped or shipped orders. Returns id, number, date, name, carrier, tracking number and country. GET /api/orders/search.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, from 1 (default 1). Pass the previous reply's next_page. | |
| limit | No | Results per page, 1-250 (default 50). | |
| fields | No | Which field to search (default All: order number, tracking number, reference, name). | |
| phrase | Yes | Search text, e.g. a name, order number or tracking number. | |
| status | No | Limit to unshipped or shipped orders (default All). | |
| include_child_accounts | No | Also search child accounts. |