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.

Admin Method

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

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Coupons
Manage Stores - all permissions
Learn more about permission scopes.
Method Declaration
Copy
Method Parameters
queryQueryRequired
Returns
Return Type:Promise<QueryCouponsResponse>
Was this helpful?
Yes
No