Get Member Coupons
1 min
GET
https://api.b.preview.loyaltyservices.io/api/v3/members/{memberIdentifier}/coupons
Path Parameters
- memberIdentifierstringrequiredExampleDescriptionMin Length1Max Length200
Query Parameters
- aggregateStatusCodestringDescription
- offerTypestringDescription
- includeAttributesbooleanDescription
- includeUsesbooleanDescription
- includeOfferAttributesbooleanDescription
- includeTransferDatabooleanDescription
Responses
200
- MemberCoupon[]
- memberCouponIdinteger<int64>ExampleDescriptionFormatint64
- memberIdentifierstringDescriptionMin Length1Max Length200
- couponCouponrequired
- 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
- sourceTypeCodestringrequiredExampleDescription
- sourceReferenceRuleCodestringExampleDescription
- sourceReferenceIdinteger<int64>requiredExampleDescriptionFormatint64
- aggregateStatusCodestringExampleDescription
- statusCodestringrequiredExampleDescription
- transferablebooleanDescription
- previouslyTransferredbooleanDescription
400
- ErrorResponse
- errorsValidationError[]Description
- codestringDescription
- fieldNamestringDescription
- messagestringDescription
- messageParametersobject[]Description
401
403
500
curl
curl --request GET \
--url https://api.b.preview.loyaltyservices.io/api/v3/members/{memberIdentifier}/coupons \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.b.preview.loyaltyservices.io/api/v3/members/{memberIdentifier}/coupons", 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/members/{memberIdentifier}/coupons")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.b.preview.loyaltyservices.io/api/v3/members/{memberIdentifier}/coupons"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// Success
[
{
"memberCouponId": 147258369,
"memberIdentifier": "",
"coupon": {
"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
}
]
},
"sourceTypeCode": "Promotion",
"sourceReferenceRuleCode": "StayBonus",
"sourceReferenceId": 147258369,
"aggregateStatusCode": "Active",
"statusCode": "Active",
"transferable": false,
"previouslyTransferred": false
}
]400
// Bad request
{
"errors": [
{
"code": "",
"fieldName": "",
"message": "",
"messageParameters": [
{}
]
}
]
}401
// Unauthorized
403
// Forbidden
500
// Internal error