managementListOrders( )

Retrieves a list of up to 50 pricing plan orders and details, given the specified sorting and filtering.

By default, this endpoint will retrieve all orders and return them sorted by createdDate in DESC, descending order. sort.fieldName supports endDate and createdDate fields and defaults to ASC, ascending order.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Orders
Read Orders
Manage Events
Learn more about app permissions.
Method Declaration
Copy
function managementListOrders(
  options: ManagementListOrdersOptions,
): Promise<ListOrdersResponse>;
Method Parameters
optionsManagementListOrdersOptions

Filtering, sorting, and pagination options.

Returns
Return Type:Promise<ListOrdersResponse>
JavaScript
import { orders } from "@wix/pricing-plans";

async function managementListOrders(options) {
  const response = await orders.managementListOrders(options);
}
Errors

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

Did this help?