Coupons [API]
| Description |
List Coupons |
| Action |
GET |
| URL |
<your URL here>/api/coupons |
| Sample Successful Response |
[{"id":2,"code":"COUPTEST","expires":null,"percentage":null,"one_time_use":false,"created_at":"2025-07-05T15:01:24.000+03:00","updated_at":"2026-07-02T17:16:04.000+03:00","is_active":false,"coupon_type":"amount","amount_discount":"200.0","order_min_amount":"0.0"}]
|
| Description |
Show Coupon |
| Action |
GET |
| URL |
<your URL here>/api/coupons/<id> |
| Sample Successful Response |
{"id":2,"code":"COUPTEST","expires":null,"percentage":null,"one_time_use":false,"created_at":"2025-07-05T15:01:24.000+03:00","updated_at":"2026-07-02T17:16:04.000+03:00","is_active":false,"coupon_type":"amount","amount_discount":"200.0","order_min_amount":"0.0"}
|
| Description |
Create Coupons |
| Action |
POST |
| URL |
<your URL here>/api/coupons |
| Sample request |
{"coupon":{"code":"TAKE25","coupon_type":"amount","amount_discount": 25,"order_min_amount": 0,"expires":null,"one_time_use":true,"is_active":true}}
|
| Sample Successful Response |
{"id":3,"code":"TAKE25","expires":null,"percentage":null,"one_time_use":true,"created_at":"2026-02-18T11:15:02.000+02:00","updated_at":"2026-02-18T11:15:02.000+02:00","is_active":true,"coupon_type":"amount","amount_discount":"25.0","order_min_amount":"0.0"}
|
| Required fields |
code unique (case-insensitive)
coupon_type "percentage" or "amount"
percentage required when coupon_type="percentage"; 0 < value ≤ 100
amount_discount required when coupon_type="amount"; value > 0
|
| Description |
Update Coupon |
| Action |
PATCH |
| URL |
<your URL here>/api/coupons/<id> |
| Sample request |
{"coupon": {"order_min_amount": 100,"is_active": false}}
|
| Sample Successful Response |
{"id":3,"code":"TAKE25","expires":null,"percentage":null,"one_time_use":true,"created_at":"2026-02-18T11:15:02.000+02:00","updated_at":"2026-02-18T11:15:02.000+02:00","is_active":false,"coupon_type":"amount","amount_discount":"25.0","order_min_amount":"100.0"}
|
| Description |
Delete Coupon |
| Action |
DELETE |
| URL |
<your URL here>/api/coupons/<id> |
Field Descriptions for Coupons
| Name |
Type |
Notes |
Description |
| id |
integer |
Returned by API |
Coupon ID |
| code |
string |
Unique (case-insensitive).Stored uppercased/trimmed. |
Coupon Code |
| coupon_type |
string |
"percentage" or "amount" |
Type of Coupon |
| percentage |
string |
Required if coupon_type = "percentage"
0 < Value ≤ 100
|
Percentage of Discount |
| amount_discount |
string |
Required if coupon_type = "amount"
Value > 0
|
Discounted amount |
| order_min_amount |
string |
Must be ≥ 0. |
Minimum order value for the coupon to apply |
| expires |
date |
YYYY-MM-DD or null |
Coupon Expiry date |
| one_time_use |
boolean |
Default: true |
Set the coupon as one-time use |
| is_active |
boolean |
Default: true |
Coupon status (active/inactive)
|
