queryCoupons( )

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

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

Authentication

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

Permissions
Manage Coupons
Manage Stores - all permissions
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
queryQueryRequired
Returns
Return Type:Promise<QueryCouponsResponse>
Was this helpful?
Yes
No