search-orders-request.md

Search Orders Request

Structure

SearchOrdersRequest

Fields

Name	Type	Tags	Description	Getter	Setter
locationIds	?(string[])	Optional	The location IDs for the orders to query. All locations must belong to the same merchant. Max: 10 location IDs.	getLocationIds(): ?array	setLocationIds(?array locationIds): void
cursor	?string	Optional	A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for your original query. For more information, see Pagination.	getCursor(): ?string	setCursor(?string cursor): void
query	?SearchOrdersQuery	Optional	Contains query criteria for the search.	getQuery(): ?SearchOrdersQuery	setQuery(?SearchOrdersQuery query): void
limit	?int	Optional	The maximum number of results to be returned in a single page. Default: 500 Max: 1000	getLimit(): ?int	setLimit(?int limit): void
returnEntries	?bool	Optional	A Boolean that controls the format of the search results. If true, SearchOrders returns OrderEntry objects. If false, SearchOrders returns complete order objects. Default: false.	getReturnEntries(): ?bool	setReturnEntries(?bool returnEntries): void

Example (as JSON)

{
  "limit": 3,
  "location_ids": [
    "057P5VYJ4A5X1",
    "18YC4JDH91E1H"
  ],
  "query": {
    "filter": {
      "date_time_filter": {
        "closed_at": {
          "end_at": "2019-03-04T21:54:45+00:00",
          "start_at": "2018-03-03T20:00:00+00:00"
        },
        "created_at": {
          "start_at": "start_at4",
          "end_at": "end_at8"
        },
        "updated_at": {
          "start_at": "start_at6",
          "end_at": "end_at6"
        }
      },
      "state_filter": {
        "states": [
          "COMPLETED"
        ]
      },
      "fulfillment_filter": {
        "fulfillment_types": [
          "DELIVERY"
        ],
        "fulfillment_states": [
          "CANCELED",
          "FAILED"
        ]
      },
      "source_filter": {
        "source_names": [
          "source_names6"
        ]
      },
      "customer_filter": {
        "customer_ids": [
          "customer_ids3",
          "customer_ids4"
        ]
      }
    },
    "sort": {
      "sort_field": "CLOSED_AT",
      "sort_order": "DESC"
    }
  },
  "return_entries": true,
  "cursor": "cursor4"
}