Skip to content

Promotions API

GET /v1/promotions
GET /v1/promotions/{id}
POST /v1/promotions

Request Body:

{
"name": "Summer 2x Points",
"type": "points_multiplier",
"multiplier": 2,
"conditions": {
"startDate": "2025-06-01",
"endDate": "2025-08-31",
"minSpend": 2000
},
"maxRedemptions": 1000
}
FieldTypeRequiredDescription
namestringYesPromotion name
typestringYesdiscount, points_multiplier, free_item, coupon
conditionsobjectNoEligibility conditions
maxRedemptionsnumberNoGlobal redemption cap
PATCH /v1/promotions/{id}
DELETE /v1/promotions/{id}
POST /v1/promotions/{promotionId}/coupons
{
"code": "SUMMER2025",
"maxUses": 500,
"maxUsesPerCustomer": 1
}
POST /v1/coupons/validate
{
"code": "SUMMER2025",
"customerId": "cust_abc123"
}
POST /v1/coupons/redeem
{
"code": "SUMMER2025",
"customerId": "cust_abc123"
}