listOrders( )


Retrieves a list of orders, including ticket data.

Authentication

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Read Events - all read permissions
Manage Events - all permissions
Read Basic Events Order Info
Manage Orders
Learn more about app permissions.
Method Declaration
Copy
function listOrders(options: ListOrdersOptions): Promise<ListOrdersResponse>;
Method Parameters
optionsListOrdersOptions

An object representing the available options for retrieving a list of orders.

Returns
Return Type:Promise<ListOrdersResponse>
JavaScript
import { orders } from "wix-events.v2"; async function listOrders(options) { try { const result = await orders.listOrders(options); return result; } catch (error) { console.error(error); // Handle the error } }
Errors

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

Did this help?