List Cart Rule Coupons
Lists every coupon code attached to a cart rule — the data behind the Coupons tab of the admin Marketing → Promotions → Cart Rules screen.
TIP
New here? Read the Cart Rule Coupons overview for what these coupons do and how they relate to a cart rule.
Endpoint
| Endpoint | Method |
|---|---|
/api/admin/marketing/cart-rules/{cartRuleId}/coupons | GET |
Response envelope
Admin collections return a { data, meta } body envelope:
data— the coupon rows for this page, scoped to the parent rule.meta—currentPage,perPage,lastPage,total,from,to.
Only coupons belonging to the named cartRuleId are returned — coupons from other rules never appear. An unknown parent rule returns a 404.
Query parameters
| Parameter | Description |
|---|---|
page, per_page | Pagination (per_page default 10, max 50) |
Fields
| Field | Type | Notes |
|---|---|---|
id | int | Coupon id |
cartRuleId | int | Parent cart-rule id |
code | string | The coupon code shoppers enter |
usageLimit | int | Total redemptions allowed (0 = unlimited; inherits the rule when unset) |
usagePerCustomer | int | Redemptions allowed per customer (0 = unlimited) |
timesUsed | int | Times redeemed so far — read-only |
type | int | 0 the rule's primary code / 1 a secondary code |
isPrimary | boolean | true for the rule's own primary code, false for secondary codes |
expiredAt | string | Expiry date (YYYY-MM-DD) or null |
createdAt | string | ISO 8601 timestamp |
updatedAt | string | ISO 8601 timestamp |
Every /api/admin/* request requires an admin Bearer token.