Coupons List
tiendanube_coupons_listRetrieve and filter Tiendanube coupons by code, status, type, validity, and date range to review promotions and manage coupon campaigns.
Instructions
List coupons. HTTP: GET /coupons Required scope: read_coupons API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | No | Exact coupon code | |
| page | No | Page number (default 1). Orders: page * per_page must be <= 10000 | |
| type | No | Coupon type (percentage | absolute | shipping) | |
| valid | No | Filter by validity | |
| fields | No | Comma-separated list of fields to return, to reduce payload size (e.g. 'id,name,variants') | |
| status | No | Coupon status (activated | deactivated) | |
| sort_by | No | Sort order | |
| per_page | No | Items per page (default 30, max 200; max 50 for external invoices) | |
| since_id | No | Only return records with an ID greater than this value (cursor pagination) | |
| max_end_date | No | End date to | |
| min_end_date | No | End date from | |
| created_at_max | No | Created at or before (ISO 8601) | |
| created_at_min | No | Created at or after (ISO 8601, e.g. 2025-01-31T00:00:00-03:00) | |
| max_start_date | No | Start date to | |
| min_start_date | No | Start date from (YYYY-MM-DD) | |
| updated_at_max | No | Updated at or before (ISO 8601) | |
| updated_at_min | No | Updated at or after (ISO 8601) | |
| response_format | No | Output format: 'json' (default, full data) or 'markdown' (human-readable) | json |