List coupons
get
https://api.flactrum.com/v1/coupons
Discount codes customers enter in the cart. A coupon applies to the order total after campaigns; usage is recorded when the order is written and given back if the order is cancelled or refunded.
| Required scope | coupons.read |
| Panel screen | Menu & products → Coupons |
| Success status | 200 |
| Returns | A paginated list of Coupon objects |
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| branch_id | query | string | Coupons valid at this branch, including those valid everywhere. |
| page | query | integer | Page number. |
| per_page | query | integer | Page size. Values above the maximum are rejected rather than silently clamped. |
| active | query | boolean | Filter by active flag. Omit to get both. |
| updated_since | query | string | Only records changed at or after this instant. Use it for incremental sync. |
| sort | query | string | Column to sort by. Each endpoint lists what it accepts. |
| direction | query | string | Sort direction. |
Response fields
| Field | Type | Description |
|---|---|---|
| id | string | — |
| code | string | Unique within the brand, always upper case. |
| name | string | — |
| description | string|null | — |
| discount_type | string | — |
| discount_value | number | — |
| max_discount | number|null | Cap for a percentage discount. |
| discount_label | string | — |
| min_order_total | number|null | — |
| starts_at | string|null | — |
| ends_at | string|null | — |
| usage_limit | integer|null | Total redemptions allowed; null means unlimited. |
| per_customer_limit | integer|null | Redemptions per registered customer. |
| used_count | integer | Redemptions so far. Cancelling or refunding the order gives the use back. |
| is_active | boolean | — |
| is_usable | boolean | Active, within dates and not used up. |
| status | string | — |
| branch_ids | array | Empty means every branch. |
Examples
No recorded example yet.