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 | [String] | The location IDs for the orders to query. All locations must belong to the same merchant. 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 | Number | Maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. Default: `500` | [optional] |
return_entries | Boolean | Boolean that controls the format of the search results. If `true`, SearchOrders will return ``OrderEntry`` objects. If `false`, SearchOrders will return complete Order objects. Default: `false`. | [optional] |