Search orders
gelato_search_ordersRead-only
Search orders and drafts, newest first: id, your reference ids, order type, fulfillment and financial status, channel, store, country, currency, totals and dates. Filter by status, type, country, channel, store, reference, date range or free text (recipient name or order reference). POST /v4/orders:search.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | No | Only these Gelato order ids. | |
| limit | No | Results per page, 1-100 (default 50). | |
| offset | No | Number of results to skip (default 0). Pass the previous reply's next_offset. | |
| search | No | Free text matched against the recipient's first or last name and orderReferenceId. | |
| channels | No | Only orders from these channels (ui, api, shopify, etsy). | |
| end_date | No | Only orders ordered or created on or before this ISO 8601 date-time. | |
| countries | No | Only orders shipping to these countries (2-letter ISO codes). | |
| store_ids | No | Only orders from these e-commerce store ids. | |
| currencies | No | Only orders in these currencies. | |
| start_date | No | Only orders ordered or created on or after this ISO 8601 date-time (e.g. 2026-10-01T00:00:00Z). | |
| order_types | No | Only these order types. | |
| financial_statuses | No | Only these financial statuses. | |
| order_reference_ids | No | Only orders with these orderReferenceIds. | |
| fulfillment_statuses | No | Only these fulfillment statuses. |