Promotions API
List Promotions
Section titled “List Promotions”GET /v1/promotionsGet Promotion
Section titled “Get Promotion”GET /v1/promotions/{id}Create Promotion
Section titled “Create Promotion”POST /v1/promotionsRequest Body:
{ "name": "Summer 2x Points", "type": "points_multiplier", "multiplier": 2, "conditions": { "startDate": "2025-06-01", "endDate": "2025-08-31", "minSpend": 2000 }, "maxRedemptions": 1000}| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Promotion name |
type | string | Yes | discount, points_multiplier, free_item, coupon |
conditions | object | No | Eligibility conditions |
maxRedemptions | number | No | Global redemption cap |
Update Promotion
Section titled “Update Promotion”PATCH /v1/promotions/{id}Delete Promotion
Section titled “Delete Promotion”DELETE /v1/promotions/{id}Coupon Endpoints
Section titled “Coupon Endpoints”Create Coupon
Section titled “Create Coupon”POST /v1/promotions/{promotionId}/coupons{ "code": "SUMMER2025", "maxUses": 500, "maxUsesPerCustomer": 1}Validate Coupon
Section titled “Validate Coupon”POST /v1/coupons/validate{ "code": "SUMMER2025", "customerId": "cust_abc123"}Redeem Coupon
Section titled “Redeem Coupon”POST /v1/coupons/redeem{ "code": "SUMMER2025", "customerId": "cust_abc123"}