managementListOrders( )

Lists pricing plan orders.

Description

The managementListOrders() function returns a Promise that resolves to a list of up to 50 pricing plan orders. You can specify options for filtering, sorting, and paginating the results.

This function returns the orders on the site. To list orders for the currently logged-in member, use memberListOrders().

Admin Method

This function requires elevated permissions to run. This function is not universal and runs only on the backend.

Syntax

function managementListOrders(options: ManagementListOrdersOptions): Promise<ListOrdersResponse>

managementListOrders Parameters

NAME

TYPE

DESCRIPTION

options

Optional

ManagementListOrdersOptions

Filtering, sorting, and pagination options.

Returns

Return Type:

Promise<

ListOrdersResponse

NAME

TYPE

DESCRIPTION

orders

Array<

Order

List of orders.

pagingMetadata

PagingMetadataV2

Object containing paging-related data (number of orders returned, offset).

Was this helpful?

managementListOrders example

Copy Code

1import { orders } from 'wix-pricing-plans.v2';
2  
3 async function managementListOrders(options) {
4   try {
5     const result = await orders.managementListOrders(options);
6
7     return result;
8   } catch (error) {
9     console.error(error);
10     // Handle the error
11   }
12 }
13