listOrders( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of up to 1000 orders, given the provided filters.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Bookings Services and Settings
Manage Orders
Read Orders
Manage Events
Manage Portfolio
Access Verticals by Automations
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
function listOrders(options: ListOrdersOptions): Promise<ListOrdersResponse>;
Method Parameters
optionsListOrdersOptions
Returns
Return Type:Promise<ListOrdersResponse>
JavaScript
import { orders } from "@wix/restaurants";

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

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

Did this help?