Appearance
Promotion Code Management
The Promotion Code API allows merchants to create and manage promotional discount campaigns, validate candidate coupon codes, preview cart totals with applied discounts, and bulk-generate unique voucher codes.
Endpoints
| Endpoint | Method | Path | Description |
|---|---|---|---|
| Fetch All Promotions | GET | /v1/promotions | List promotional campaigns |
| Create Promotion | POST | /v1/promotions | Create a promotion with discount rules |
| Show Promotion | GET | /v1/promotions/{promotionId} | Get promotion details |
| Update Promotion | PATCH | /v1/promotions/{promotionId} | Update promotional rules |
| Delete Promotion | DELETE | /v1/promotions/{promotionId} | Remove a promotion |
| Apply Promo Code | POST | /v1/promotions/apply/promo-code | Apply code to a cart session |
| Preview Cart Promotions | POST | /v1/promotions/preview | Price cart against promo code and automatic discounts |
| Check Code Availability | GET / POST | /v1/promotions/check-code(s)-availability | Check single or multiple codes for clashes |
| Promotion Lifecycle | POST | /v1/promotions/{id}/publish,pause... | Transition status (publish, pause, resume, archive, duplicate) |
| Unique Codes Management | GET / POST | /v1/promotions/{id}/codes... | Generate, list, disable, and export unique single-use codes |
| Statistics and Summary | GET | /v1/promotions/summary,stats... | Performance KPIs, summary, and order redemptions |
