searchOrders( )

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
filter: {"status": {"$ne": "INITIALIZED"}} - other order statuses can be queried, but orders with status: "INITIALIZED" are never returned

To learn about working with Search endpoints, see API Query Language, and Sorting and Paging.

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`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte`
`_updatedDate`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte`
`balanceSummary.authorized.amount`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`balanceSummary.pending.amount`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`balanceSummary.pendingRefund.amount`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`billingInfo.contactDetails.firstName`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`billingInfo.contactDetails.lastName`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`businessLocation._id`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`businessLocation.name`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`buyerInfo.email`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`number`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte`
`priceSummary.total.amount`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`purchasedDate`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte`
`shippingInfo.logistics.deliveryTime`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`shippingInfo.logistics.deliveryTimeSlot.from`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte`
`shippingInfo.logistics.deliveryTimeSlot.to`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte`
`taxInfo.totalExempt.amount`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`taxInfo.totalTax.amount`	Search: ✗ Sort: `ASC`, `DESC`	`$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte`
`archived`	Search: ✗ Sort: ✗	`$eq`, `$ne`, `$exists`, `$in`, `$any`
`seenByAHuman`	Search: ✗ Sort: ✗	`$eq`, `$ne`, `$exists`, `$in`, `$any`
`_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`
`fulfillmentStatusesAggregate.statuses`	Search: ✗ Sort: `ASC`, `DESC`	`$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 and Wix apps, use elevated permissions.
In Wix Headless projects, use API key authentication.

Permissions

Learn more about app permissions.

Method Declaration

Copy

Method Parameters

searchCursorSearchRequired

Search options.

Returns

Return Type:Promise<SearchOrdersResponse>

Errors

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

Did this help?