Promo Codes API
Limio allows you to create promo codes programmatically.
This API allows you to create a new promo code object in Limio. Only promo codes v2 are supported.
Authorizations
Body
namestringRequiredExample:
The object name. Not included values will not be updated and nested values will require the structure to update. Updates will only occur for the id provided. WARNING! Changing this field might break integrations
abc123
idstringRequiredExample:
The object id. This is the record_type and name concatenated such as promo_code_v2-abc123. Not included values will not be updated and nested values will require the structure to update. Updates will only occur for the id provided. WARNING! Changing this field might break integrations
promo_code_v2-abc123
dataone ofRequired
all ofOptional
and
all ofOptional
and
Responses
200
OK
application/json
400
Bad request (missing required fields)
401
Unauthorized
application/json
404
Not found
post
POST /api/objects/limio/promo_codes_v2 HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 449
{
"name": "abc123",
"id": "promo_code_v2-abc123",
"data": {
"applicationLevel": "wholeBasket",
"promoCode": "abc123",
"status": true,
"description": "",
"promoStartDate": "2024-11-11",
"promoExpiryDate": "2024-12-31",
"productDetails": {
"product": {
"path": "/products/Discounts"
},
"ratePlan": {
"path": "'30% Off Monthly' 1 month only"
}
},
"usage": {
"availableQuantity": 100
},
"discount": {
"discountType": "text",
"percentageDiscount": 12,
"durationLength": 1,
"durationType": "Months"
}
}
}
{
"id": "promo_code_v2-CODE123",
"name": "CODE123",
"status": "active",
"record_type": "promo_code_v2",
"service": "limio",
"data": {
"promoStartDate": "2024-10-07"
}
}
Last updated
Was this helpful?