v1
latestOpenAPI 3.0.02026-07-2480129136.5 KBSearch Orders
Search Orders.
Path parameters
Required. A unique key used to identify the caller of the API.
Query parameters
If provided, only return the order for the order number specified.
If provided, only return orders where the buyer's name contains the specified string. Format "Firstname, Lastname".
If provided, only return orders where the buyer's email address contains the specified string.
If provided, only return orders with ProductAmt >= the specified value.
If provided, only return orders with ProductAmt <= the specified value.
A comma delimited list of order channel Ids. If provided, only return orders from the specified channels.
A comma delimited list of order status Ids. If provided, only return orders in the specified order statuses.
A comma delimited list of pickup status Ids. If provided, only return orders in the specified pickup statuses.
A comma delimited list of deliveryTypeIds. If provided, only return orders in the specified delivery types.
A comma delimited list of presale status Ids. If provided, only return orders in the specified presale statuses.
A comma delimited list of order type Ids. If provided, only return orders in the specified order types.
Used for sorting. Default is "OrderStatus Asc". Acceptable sort terms are: OrderNumber, OrderDate, OrderStatus, ShippingName, ProductAmt, ShippingAmt, SellerTaxAmt, OrderAmt
Used for paging. The number of order numbers to skip. Default is 0.
Used for paging. The maximum number of order numbers to return. Default is 10.
Response
OK