The request does not have any required fields. When given no query criteria, SearchOrders will return all results for all of the merchant’s locations. When fetching additional pages using a cursor, the query must be equal to the query used to fetch the first page of results.
| Name | Type | Description | Notes |
|---|---|---|---|
| location_ids | Array<String> | The location IDs for the orders to query. The caller must have access to all provided locations. Min: 1 `location_ids`. Max: 10 `location_ids`. | [optional] |
| cursor | String | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See Pagination for more information. | [optional] |
| query | SearchOrdersQuery | Query conditions used to filter or sort the results. Note that when fetching additional pages using a `cursor`, the `query` must be equal to the `query` used to fetch the first page of results. | [optional] |
| limit | Integer | Number of results to be returned in a single page. SearchOrders may use a smaller limit than specified depending on server load. If the response includes a `cursor` field, you can use it to retrieve the next set of results. Default: `500` | [optional] |
| return_entries | BOOLEAN | If set to `true`, SearchOrders will return `OrderEntry` objects instead of `Order` objects. `OrderEntry` objects are lightweight descriptions of orders that include `order_id`s. Default: `false`. | [optional] |