API Explorer

You are viewing an old version of the API

All Versions

Search orders

POST /v2/orders/search

Search all orders for one or more locations.

Open in API Reference

Access Tokens Sign in to populate your access tokens from the developer dashboard Sign In

Body

cursor

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.

string

limit

The 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

Min 1

integer

location_ids

The location IDs for the orders to query. All locations must belong to the same merchant.

Min: 1 location ID.

Max: 10 location IDs.

string[]

query

Query conditions used to filter or sort the results. Note that when retrieving additional pages using a cursor, you must use the original query.

SearchOrdersQuery

filter

Criteria to filter results by.

SearchOrdersFilter

customer_filter

Filter by customers associated with the order.

SearchOrdersCustomerFilter

date_time_filter

Filter for results within a time range.

Important: If you filter for orders by time range, you must set SearchOrdersSort to sort by the same field. Learn more about filtering orders by time range.

SearchOrdersDateTimeFilter

closed_at

The time range for filtering on the closed_at timestamp. If you use this value, you must set the sort_field in the OrdersSearchSort object to CLOSED_AT.

TimeRange

end_at

A datetime value in RFC 3339 format indicating when the time range ends.

string

start_at

A datetime value in RFC 3339 format indicating when the time range starts.

string

created_at

The time range for filtering on the created_at timestamp. If you use this value, you must set the sort_field in the OrdersSearchSort object to CREATED_AT.

TimeRange

updated_at

The time range for filtering on the updated_at timestamp. If you use this value, you must set the sort_field in the OrdersSearchSort object to UPDATED_AT.

TimeRange

fulfillment_filter

Filter by the fulfillment type or state.

SearchOrdersFulfillmentFilter

source_filter

Filter by the source of the order.

SearchOrdersSourceFilter

state_filter

Filter by OrderState.

SearchOrdersStateFilter

states

States to filter for.

string [ ]

Select states

COMPLETED Indicates that the order is completed. Completed orders are fully paid. This is a terminal state.

sort

Criteria to sort results by.

SearchOrdersSort

sort_field

The field to sort by.

Important: When using a DateTimeFilter, sort_field must match the timestamp field that the DateTimeFilter uses to filter. For example, if you set your sort_field to CLOSED_AT and you use a DateTimeFilter, your DateTimeFilter must filter for orders by their CLOSED_AT date. If this field does not match the timestamp field in DateTimeFilter, SearchOrders returns an error.

Default: CREATED_AT.

string

Select sort_field

CLOSED_AT The time when the order was closed, in RFC-3339 format. If you use this value, you must also set a StateFilter with closed states. If you are also filtering for a time range in this query, you must set the CLOSED_AT field in your DateTimeFilter.

sort_order

The chronological order in which results are returned. Defaults to DESC.

string

Select sort_order

DESC The results are returned in descending e.g., newest-first or Z-A order.

return_entries

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.

boolean

You are viewing an old version of the API

All Versions

Request

cURL

Response

// No response received yet.

Thanks for the feedback. For more help, check out our support resources.

Developer Support Developer Forums

There was an error submitting feedback. Try again later.

Developer Support Developer Forums