Search...
listOrders( )
Retrieves a list of orders, including ticket data.
Admin Method
This function requires elevated permissions to run. This function is not universal and runs only on the backend.
Syntax
function listOrders(options: ListOrdersOptions): Promise<ListOrdersResponse>
listOrders Parameters
NAME
TYPE
DESCRIPTION
options
Optional
ListOrdersOptions
An object representing the available options for retrieving a list of orders.
Returns
Return Type:
Promise<
ListOrdersResponse
>NAME
TYPE
DESCRIPTION
facets
Record<
string
>,
FacetCountsFilter facets.
limit
number
Limit.
offset
number
Offset.
orderFacets
OrderFacets
Order data enriched facets.
orders
Array<
Order
>Orders.
total
number
Total orders matching the given filters.
Was this helpful?
listOrders example
Copy Code
1import { orders } from 'wix-events.v2';23 async function listOrders(options) {4 try {5 const result = await orders.listOrders(options);67 return result;8 } catch (error) {9 console.error(error);10 // Handle the error11 }12 }13