Actions25
- Store Actions
- Product Actions
- Category Actions
- Variation Actions
- Brand Actions
- Coupon Actions
- Report Actions
- Engage Profile Actions
- Engage Unsubscribe Actions
- Search Actions
Coupon → List
AI-generatedSummary
List coupons within a specified date range with optional pagination, sorting, and keyword filtering.
Inputs
- Start Date (required) — Start date in YYYY-MM-DD format (store timezone) to specify the beginning of the date range for the coupons returned.
- End Date (required) — End date in YYYY-MM-DD format (store timezone) to specify the end of the date range for the coupons returned.
- Additional Options — Optional parameters for pagination, sorting, and filtering including page number, results per page (max 100), field to sort by, order direction (ascending or descending), and a search keyword to filter coupons by name or keyword.
Output shape
a list of coupon items matching the specified criteria
Results are paginated according to the provided page and per_page values, defaults to page 1 and 25 items per page. Each coupon item includes usage and discount totals. The list is retrieved from the Metorik API's /coupons endpoint using the specified date range and additional filters.
Examples
Example 1: Retrieve all coupons used between 2026-04-01 and 2026-04-04, sorted by creation date descending, 25 per page on the first page.
Start Date = 2026-04-01, End Date = 2026-04-04, Additional Options = { page: 1, per_page: 25, order_by: 'product_created_at', order_dir: 'desc' }