queryCoupons( )

Retrieves a list of up to 100 coupons with pagination and filters.

Description

The queryCoupons() function returns a Promise that resolves when the coupons are retrieved.

Admin Method

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

Syntax

function queryCoupons(query: Query): Promise<QueryCouponsResponse>

queryCoupons Parameters

NAME

TYPE

DESCRIPTION

query

Query

Returns

Return Type:

Promise<

QueryCouponsResponse

NAME

TYPE

DESCRIPTION

coupons

Array<

Coupon

Returned coupons.

totalResults

number

Total results.

Was this helpful?

queryCoupons example

Copy Code

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