Skip to content

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 ​

EndpointMethodPathDescription
Fetch All PromotionsGET/v1/promotionsList promotional campaigns
Create PromotionPOST/v1/promotionsCreate a promotion with discount rules
Show PromotionGET/v1/promotions/{promotionId}Get promotion details
Update PromotionPATCH/v1/promotions/{promotionId}Update promotional rules
Delete PromotionDELETE/v1/promotions/{promotionId}Remove a promotion
Apply Promo CodePOST/v1/promotions/apply/promo-codeApply code to a cart session
Preview Cart PromotionsPOST/v1/promotions/previewPrice cart against promo code and automatic discounts
Check Code AvailabilityGET / POST/v1/promotions/check-code(s)-availabilityCheck single or multiple codes for clashes
Promotion LifecyclePOST/v1/promotions/{id}/publish,pause...Transition status (publish, pause, resume, archive, duplicate)
Unique Codes ManagementGET / POST/v1/promotions/{id}/codes...Generate, list, disable, and export unique single-use codes
Statistics and SummaryGET/v1/promotions/summary,stats...Performance KPIs, summary, and order redemptions

Build with joy