Create a coupon
post
https://api.flactrum.com/v1/coupons
| Required scope | coupons.write |
| Success status | 201 |
| Returns | One Coupon object |
Request body
| Field | Type | Description |
|---|---|---|
| code * | string | Stored in upper case. |
| name * | string | — |
| description | string|null | — |
| discount_type * | string | — |
| discount_value * | number | Percentage discounts cannot exceed 100. |
| max_discount | number|null | — |
| min_order_total | number|null | — |
| starts_at | string|null | — |
| ends_at | string|null | Must be after starts_at. |
| usage_limit | integer|null | — |
| per_customer_limit | integer|null | — |
| is_active | boolean | — |
| branch_ids | array | Omit or send empty for every branch. |
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.