POST

Search Orders

Retrieves a list of orders, given the provided paging, filtering, and sorting.

Search Orders runs with these defaults, which you can override:

createdDate is sorted in DESC order.
cursorPaging.limit is 100.

Notes:

By default, Search Orders doesn't return orders with status: "PENDING" or status: "REJECTED". To retrieve them, filter for the relevant status explicitly. For example, {"filter": {"status": "PENDING"}}.
Search Orders never returns orders with status: "INITIALIZED", regardless of the filter applied. To retrieve an order with status: "INITIALIZED", use Get Order.

To learn how to query or search orders, see API Query Language.

Property	Capabilities	Filters
`channelInfo.type`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$in`, `$ne`, `$nin`
`fulfillmentStatus`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$in`, `$ne`, `$nin`
`paymentStatus`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$in`, `$ne`, `$nin`
`shippingInfo.region.name`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$in`, `$ne`, `$nin`
`shippingInfo.title`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$in`, `$ne`, `$nin`
`status`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$in`, `$ne`, `$nin`
`_createdDate`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`
`_updatedDate`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`
`balanceSummary.authorized.amount`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`balanceSummary.pending.amount`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`balanceSummary.pendingRefund.amount`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`billingInfo.contactDetails.firstName`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`billingInfo.contactDetails.lastName`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`businessLocation._id`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`businessLocation.name`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`buyerInfo.email`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`number`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`
`priceSummary.total.amount`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`purchasedDate`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`
`shippingInfo.logistics.deliveryTime`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`shippingInfo.logistics.deliveryTimeSlot.from`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`
`shippingInfo.logistics.deliveryTimeSlot.to`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`
`taxInfo.totalTax.amount`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`
`archived`	Search: ✗ Sort: ✗	`$eq`, `$ne`, `$in`, `$exists`
`imported`	Search: ✗ Sort: ✗	`$eq`, `$ne`, `$in`, `$exists`
`seenByAHuman`	Search: ✗ Sort: ✗	`$eq`, `$ne`, `$in`, `$exists`
`_id`	Search: ✗ Sort: ✗	`$eq`, `$in`, `$ne`, `$nin`
`buyerInfo.contactId`	Search: ✗ Sort: ✗	`$eq`, `$in`, `$ne`, `$nin`
`buyerInfo.memberId`	Search: ✗ Sort: ✗	`$eq`, `$in`, `$ne`, `$nin`
`channelInfo.externalOrderId`	Search: ✗ Sort: ✗	`$eq`, `$in`, `$ne`, `$nin`
`checkoutId`	Search: ✗ Sort: ✗	`$eq`, `$in`, `$ne`, `$nin`
`createdBy.userId`	Search: ✗ Sort: ✗	`$eq`, `$in`, `$ne`, `$nin`
`lineItems.subscriptionInfo._id`	Search: ✗ Sort: ✗	`$eq`, `$in`, `$ne`, `$nin`
`lineItems.catalogReference.appId`	Search: ✗ Sort: ✗	`$hasAll`, `$hasSome`
`lineItems.catalogReference.catalogItemId`	Search: ✗ Sort: ✗	`$hasAll`, `$hasSome`
`lineItems.locations._id`	Search: ✗ Sort: ✗	`$hasAll`, `$hasSome`
`lineItems.productName.original`	Search: ✗ Sort: `ASC`, `DESC`	`$hasAll`, `$hasSome`

Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

In Wix sites, Wix apps, and Wix-Managed Headless projects, use elevated permissions.
In Self-Managed Headless projects, use API key authentication.

Permissions

Learn more about app permissions.

Method Declaration

Copy

Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?