Create a coupon request.
1 min
POST
https://api.b.preview.loyaltyservices.io/api/v3/coupon-requests
Query Parameters
- activateCouponsbooleanDescriptionDefaultfalse
- useCouponsbooleanDescriptionDefaultfalse
- asyncbooleanDescriptionDefaultfalse
Body Parameters
- bodyCouponRequestrequiredDescription
- offerCodestringrequiredExampleDescriptionMax Length50
- namestringrequiredDescriptionMax Length300
- descriptionstringDescriptionMax Length500
- expirationTypestringExampleDescriptionDefaultRolling
- startDatestring<date>DescriptionFormatdate
- expirationDatestring<date>DescriptionFormatdate
- expirationDayPeriodinteger<int32>ExampleDescriptionFormatint32
- expirationTimePeriodinteger<int32>ExampleDescriptionFormatint32
- useTypeCodestringExampleDescriptionDefaultSingle
- couponRequestTypestringExampleDescriptionDefaultBulk
- memberIdentifierstringDescription
- couponCountinteger<int32>ExampleDescriptionDefault1Formatint32
- attributesCouponRequestAttribute[]Description
- namestringrequiredExampleDescriptionMax Length300
- valuestringrequiredExampleDescriptionMax Length50
Responses
200
- Coupon[]
- couponIdinteger<int64>ExampleDescriptionFormatint64
- couponRequestIdinteger<int64>ExampleDescriptionFormatint64
- offerOfferDescription
- offerIdinteger<int64>ExampleDescriptionFormatint64
- offerTypeCodestringrequiredExampleDescription
- codestringExampleDescription
- namestringExampleDescription
- descriptionstringExampleDescription
- featureVersioninteger<int32>ExampleDescriptionFormatint32
- statusCodestringrequiredExampleDescription
- startDateTimestring<date-time>DescriptionFormatdate-time
- endDateTimestring<date-time>DescriptionFormatdate-time
- offerAttributesOfferAttribute[]Description
- offerAttributeIdinteger<int64>ExampleDescriptionFormatint64
- attributeAttributerequired
- attributeIdinteger<int64>ExampleDescriptionFormatint64
- typeCodestringrequiredExampleDescription
- statusCodestringrequiredExampleDescription
- namestringExampleDescription
- descriptionstringExampleDescription
- dataTypeCodestringrequiredExampleDescription
- defaultValuestringExampleDescription
- requireOnUsebooleanExampleDescription
- requireOnHoldbooleanExampleDescription
- includeOnResponsebooleanDescription
- attributeTypeCodestringExampleDescription
- operatorCodestringExampleDescription
- operandstringExampleDescription
- smartGroupIdinteger<int64>ExampleDescriptionFormatint64
- codestringExampleDescription
- statusCodestringExampleDescription
- startDatestring<date>DescriptionFormatdate
- endDatestring<date>DescriptionFormatdate
- useTypeCodestringExampleDescriptionDefaultSingle
- useLimitinteger<int32>ExampleDescriptionDefault1Formatint32
- currentUseinteger<int32>ExampleDescriptionFormatint32
- couponUsesCouponUse[]Description
- useDateTimestring<date-time>DescriptionFormatdate-time
- statusCodestringrequiredExampleDescription
- channelCodestringrequiredExampleDescription
- aliasstringDescription
- useCountinteger<int32>requiredExampleDescriptionFormatint32
- couponUseAttributesCouponUseAttribute[]Description
- couponUseAttributeIdinteger<int64>ExampleDescriptionFormatint64
- attributeAttributerequired
- attributeIdinteger<int64>ExampleDescriptionFormatint64
- typeCodestringrequiredExampleDescription
- statusCodestringrequiredExampleDescription
- namestringExampleDescription
- descriptionstringExampleDescription
- dataTypeCodestringrequiredExampleDescription
- valuestringExampleDescription
- couponAttributesCouponAttribute[]Description
- couponAttributeIdinteger<int64>ExampleDescriptionFormatint64
- attributeAttributerequired
- attributeIdinteger<int64>ExampleDescriptionFormatint64
- typeCodestringrequiredExampleDescription
- statusCodestringrequiredExampleDescription
- namestringExampleDescription
- descriptionstringExampleDescription
- dataTypeCodestringrequiredExampleDescription
- valuestringExampleDescription
- requireOnUsebooleanExampleDescription
- requireOnHoldbooleanDescription
202
- AsyncTask
- asyncTaskIdinteger<int64>Formatint64
- taskTypeCodestringExampleDescription
- taskCodestringExampleDescription
- requestDatestring<date-time>DescriptionFormatdate-time
- requestDataobjectDescription
- statusCodestringDescription
- responseDatestring<date-time>DescriptionFormatdate-time
- responseDataobjectDescription
- fileNamestringDescription
- lineNumberintegerDescription
- fileDatastringDescription
400
- ErrorResponse
- errorsValidationError[]Description
- codestringDescription
- fieldNamestringDescription
- messagestringDescription
- messageParametersobject[]Description
401
403
500
curl
curl --request POST \
--url 'https://api.b.preview.loyaltyservices.io/api/v3/coupon-requests?activateCoupons=boolean&useCoupons=boolean&async=boolean' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"offerCode": "Offer12345",
"name": "",
"expirationType": "Rolling",
"useTypeCode": "Single",
"couponRequestType": "Bulk",
"couponCount": 1,
"attributes": [
{
"name": "site_tier",
"value": 123
}
]
}'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var raw = JSON.stringify({
"offerCode": "Offer12345",
"name": "",
"expirationType": "Rolling",
"useTypeCode": "Single",
"couponRequestType": "Bulk",
"couponCount": 1,
"attributes": [
{
"name": "site_tier",
"value": 123
}
]
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://api.b.preview.loyaltyservices.io/api/v3/coupon-requests?activateCoupons=boolean&useCoupons=boolean&async=boolean", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.b.preview.loyaltyservices.io/api/v3/coupon-requests?activateCoupons=boolean&useCoupons=boolean&async=boolean")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
"offerCode": "Offer12345",
"name": "",
"expirationType": "Rolling",
"useTypeCode": "Single",
"couponRequestType": "Bulk",
"couponCount": 1,
"attributes": [
{
"name": "site_tier",
"value": 123
}
]
})
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.b.preview.loyaltyservices.io/api/v3/coupon-requests?activateCoupons=boolean&useCoupons=boolean&async=boolean"
payload = json.dumps({
"offerCode": "Offer12345",
"name": "",
"expirationType": "Rolling",
"useTypeCode": "Single",
"couponRequestType": "Bulk",
"couponCount": 1,
"attributes": [
{
"name": "site_tier",
"value": 123
}
]
})
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
200
// Success
[
{
"couponId": 147258369,
"couponRequestId": 147258370,
"offer": {
"offerId": 147258369,
"offerTypeCode": "Discount",
"code": "ALON2020",
"name": "Free night",
"description": "Award double points",
"featureVersion": 2,
"statusCode": "Enabled",
"startDateTime": "",
"endDateTime": "",
"offerAttributes": [
{
"offerAttributeId": 147258369,
"attribute": {
"attributeId": 147258369,
"typeCode": "Validation",
"statusCode": "Enabled",
"name": "AccountNumber",
"description": "Account Number",
"dataTypeCode": "open"
},
"defaultValue": "Standard",
"requireOnUse": true,
"requireOnHold": true,
"includeOnResponse": false,
"attributeTypeCode": "Validation",
"operatorCode": "EQ",
"operand": "GI",
"smartGroupId": 147258369
}
]
},
"code": "ZPVWTAROW2OQ",
"statusCode": "Activated",
"startDate": "",
"endDate": "",
"useTypeCode": "Single",
"useLimit": 1,
"currentUse": 1,
"couponUses": [
{
"useDateTime": "",
"statusCode": "Used",
"channelCode": "System",
"alias": "",
"useCount": 1,
"couponUseAttributes": [
{
"couponUseAttributeId": 147258369,
"attribute": {
"attributeId": 147258369,
"typeCode": "Validation",
"statusCode": "Enabled",
"name": "AccountNumber",
"description": "Account Number",
"dataTypeCode": "open"
},
"value": "Standard"
}
]
}
],
"couponAttributes": [
{
"couponAttributeId": 147258369,
"attribute": {
"attributeId": 147258369,
"typeCode": "Validation",
"statusCode": "Enabled",
"name": "AccountNumber",
"description": "Account Number",
"dataTypeCode": "open"
},
"value": "2021-12-31T12:00:00",
"requireOnUse": true,
"requireOnHold": false
}
]
}
]202
// Accepted
{
"asyncTaskId": "",
"taskTypeCode": "PlatformAPI",
"taskCode": "enrollMember",
"requestDate": "",
"requestData": {},
"statusCode": "",
"responseDate": "",
"responseData": {},
"fileName": "",
"lineNumber": 0,
"fileData": ""
}400
// Bad request
{
"errors": [
{
"code": "",
"fieldName": "",
"message": "",
"messageParameters": [
{}
]
}
]
}401
// Unauthorized
403
// Forbidden
500
// Internal error