search-orders-response.md

Search Orders Response

Either the order_entries or orders field is set, depending on whether return_entries is set on the SearchOrdersRequest.

Structure

Search Orders Response

Fields

Name	Type	Tags	Description
order_entries	List of Order Entry	Optional	A list of OrderEntries that fit the query conditions. The list is populated only if return_entries is set to true in the request.
orders	List of Order	Optional	A list of Order objects that match the query conditions. The list is populated only if return_entries is set to false in the request.
cursor	string	Optional	The pagination cursor to be used in a subsequent request. If unset, this is the final response. For more information, see Pagination.
errors	List of Error	Optional	Errors encountered during the search.

Example (as JSON)

{
  "cursor": "123",
  "order_entries": [
    {
      "location_id": "057P5VYJ4A5X1",
      "order_id": "CAISEM82RcpmcFBM0TfOyiHV3es",
      "version": 1
    },
    {
      "location_id": "18YC4JDH91E1H",
      "order_id": "CAISENgvlJ6jLWAzERDzjyHVybY"
    },
    {
      "location_id": "057P5VYJ4A5X1",
      "order_id": "CAISEM52YcpmcWAzERDOyiWS3ty"
    }
  ]
}