v1

latestOpenAPI 3.0.02026-07-2480129136.5 KB
Stores

Search Orders

Search Orders.

get/stores/{storeKey}/orders

Path parameters

storeKeystring required

Required. A unique key used to identify the caller of the API.

Query parameters

orderNumberstring

If provided, only return the order for the order number specified.

customerNamestring

If provided, only return orders where the buyer's name contains the specified string. Format "Firstname, Lastname".

customerEmailstring

If provided, only return orders where the buyer's email address contains the specified string.

minOrderValuenumber double

If provided, only return orders with ProductAmt >= the specified value.

maxOrderValuenumber double

If provided, only return orders with ProductAmt <= the specified value.

channelIdsstring

A comma delimited list of order channel Ids. If provided, only return orders from the specified channels.

orderStatusIdsstring

A comma delimited list of order status Ids. If provided, only return orders in the specified order statuses.

pickupStatusIdsstring

A comma delimited list of pickup status Ids. If provided, only return orders in the specified pickup statuses.

deliveryTypeIdsstring

A comma delimited list of deliveryTypeIds. If provided, only return orders in the specified delivery types.

presaleStatusIdsstring

A comma delimited list of presale status Ids. If provided, only return orders in the specified presale statuses.

orderTypeIdsstring

A comma delimited list of order type Ids. If provided, only return orders in the specified order types.

sortstring

Used for sorting. Default is "OrderStatus Asc". Acceptable sort terms are: OrderNumber, OrderDate, OrderStatus, ShippingName, ProductAmt, ShippingAmt, SellerTaxAmt, OrderAmt

offsetinteger

Used for paging. The number of order numbers to skip. Default is 0.

limitinteger

Used for paging. The maximum number of order numbers to return. Default is 10.

Response

OK

totalItemsinteger
successboolean
errorsstring[]
resultsstring[]