Get Redemption Items
1 min
GET
https://api.b.preview.loyaltyservices.io/api/v3/redemption-items
Query Parameters
- memberIdentifierstringDescriptionMin Length1Max Length200
- codestringDescription
- typeCodestringDescription
- descriptionstringDescription
- convertCurrencyAttributesbooleanDescription
- convertToIsoCurrencyCodestringDescriptionMin Length0Max Length3
- ace01Keysstring[]Description
- ace02Keysstring[]Description
- ace03Keysstring[]Description
- ace04Keysstring[]Description
- ace05Keysstring[]Description
- ace06Keysstring[]Description
- ace07Keysstring[]Description
- ace08Keysstring[]Description
- ace09Keysstring[]Description
- ace10Keysstring[]Description
- ace11Keysstring[]Description
- ace12Keysstring[]Description
- ace13Keysstring[]Description
- ace14Keysstring[]Description
- ace15Keysstring[]Description
Responses
200
- RedemptionItem[]
- redemptionItemIdinteger<int64>DescriptionFormatint64
- redemptionItemCodestringDescription
- typeCodestringDescription
- descriptionstringDescription
- currencyRequirednumberDescription
- minimumQuantityinteger<int32>DescriptionFormatint32
- maximumQuantityinteger<int32>DescriptionFormatint32
- redeemIncrementinteger<int32>DescriptionFormatint32
- faceValuenumberDescription
- convertedFaceValuenumberDescription
- convertedFaceValueIsoCurrencyCodestringDescription
- amountProvidedbooleanDescription
- companyCodestringDescription
- redeemTextstringDescription
- redeemablebooleanDescription
- poolRedeemablebooleanDescription
- requireAddressbooleanDescription
- requirePartnerAccountNumberbooleanDescription
- fulfillmentPathCodestringDescription
- sortValuestringDescription
- customDataSmartGroupCustomData
- ace01stringDescription
- ace01DescriptionstringDescription
- ace02stringDescription
- ace02DescriptionstringDescription
- ace03stringDescription
- ace03DescriptionstringDescription
- ace04stringDescription
- ace04DescriptionstringDescription
- ace05stringDescription
- ace05DescriptionstringDescription
- ace06stringDescription
- ace06DescriptionstringDescription
- ace07stringDescription
- ace07DescriptionstringDescription
- ace08stringDescription
- ace08DescriptionstringDescription
- ace09stringDescription
- ace09DescriptionstringDescription
- ace10stringDescription
- ace10DescriptionstringDescription
- ace11stringDescription
- ace11DescriptionstringDescription
- ace12stringDescription
- ace12DescriptionstringDescription
- ace13stringDescription
- ace13DescriptionstringDescription
- ace14stringDescription
- ace14DescriptionstringDescription
- ace15stringDescription
- ace15DescriptionstringDescription
- ace01SmartGroupIdinteger<int64>DescriptionFormatint64
- ace02SmartGroupIdinteger<int64>DescriptionFormatint64
- ace03SmartGroupIdinteger<int64>DescriptionFormatint64
- ace04SmartGroupIdinteger<int64>DescriptionFormatint64
- ace05SmartGroupIdinteger<int64>DescriptionFormatint64
- ace06SmartGroupIdinteger<int64>DescriptionFormatint64
- ace07SmartGroupIdinteger<int64>DescriptionFormatint64
- ace08SmartGroupIdinteger<int64>DescriptionFormatint64
- ace09SmartGroupIdinteger<int64>DescriptionFormatint64
- ace10SmartGroupIdinteger<int64>DescriptionFormatint64
- ace11SmartGroupIdinteger<int64>DescriptionFormatint64
- ace12SmartGroupIdinteger<int64>DescriptionFormatint64
- ace13SmartGroupIdinteger<int64>DescriptionFormatint64
- ace14SmartGroupIdinteger<int64>DescriptionFormatint64
- ace15SmartGroupIdinteger<int64>DescriptionFormatint64
- genericItemGenericItem
- contentCodestringrequiredExampleDescription
- contentTypeCodestringExampleDescription
- namestringExampleDescriptionMax Length50
- shortDescriptionstringExampleDescriptionMax Length500
- descriptionstringExampleDescription
- alternateDescriptionstringExampleDescription
- termsAndConditionsstringExampleDescription
- titlestringExampleDescriptionMax Length200
- labelstringExampleDescriptionMax Length255
- logoKeystringExampleDescription
- displayTypeKeystringExampleDescription
- startDatestring<date-time>DescriptionFormatdate-time
- endDatestring<date-time>DescriptionFormatdate-time
- urlstringExampleDescriptionMax Length1000
- tierCodestringExampleDescription
- displayForAllbooleanExampleDescription
- descriptorCodestringExampleDescription
- bonusesRedemptionItemBonus[]Description
- bonusCodestringDescription
- minimumQuantityinteger<int32>DescriptionFormatint32
- maximumQuantityinteger<int32>DescriptionFormatint32
- resultAmountnumberDescription
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/redemption-items \
--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/redemption-items", 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/redemption-items")
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/redemption-items"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// Success
[
{
"redemptionItemId": "",
"redemptionItemCode": "",
"typeCode": "",
"description": "",
"currencyRequired": 0,
"minimumQuantity": "",
"maximumQuantity": "",
"redeemIncrement": "",
"faceValue": 0,
"convertedFaceValue": 0,
"convertedFaceValueIsoCurrencyCode": "",
"amountProvided": false,
"companyCode": "",
"redeemText": "",
"redeemable": false,
"poolRedeemable": false,
"requireAddress": false,
"requirePartnerAccountNumber": false,
"fulfillmentPathCode": "",
"sortValue": "",
"customData": {
"ace01": "",
"ace01Description": "",
"ace02": "",
"ace02Description": "",
"ace03": "",
"ace03Description": "",
"ace04": "",
"ace04Description": "",
"ace05": "",
"ace05Description": "",
"ace06": "",
"ace06Description": "",
"ace07": "",
"ace07Description": "",
"ace08": "",
"ace08Description": "",
"ace09": "",
"ace09Description": "",
"ace10": "",
"ace10Description": "",
"ace11": "",
"ace11Description": "",
"ace12": "",
"ace12Description": "",
"ace13": "",
"ace13Description": "",
"ace14": "",
"ace14Description": "",
"ace15": "",
"ace15Description": "",
"ace01SmartGroupId": "",
"ace02SmartGroupId": "",
"ace03SmartGroupId": "",
"ace04SmartGroupId": "",
"ace05SmartGroupId": "",
"ace06SmartGroupId": "",
"ace07SmartGroupId": "",
"ace08SmartGroupId": "",
"ace09SmartGroupId": "",
"ace10SmartGroupId": "",
"ace11SmartGroupId": "",
"ace12SmartGroupId": "",
"ace13SmartGroupId": "",
"ace14SmartGroupId": "",
"ace15SmartGroupId": ""
},
"genericItem": {
"contentCode": "Bonus100",
"contentTypeCode": "HEADER",
"name": "Bonus 100 points",
"shortDescription": "Award 100 points",
"description": "Award 100 points on 100th stay",
"alternateDescription": "Award 100 points on 100th stay",
"termsAndConditions": "Terms and conditions for this promotion",
"title": "Award 100 points",
"label": "100 points awarded",
"logoKey": "100-points.png",
"displayTypeKey": "100 points",
"startDate": "",
"endDate": "",
"url": "/loyaltyprogram/bonus/100-points",
"tierCode": "B",
"displayForAll": true,
"descriptorCode": "LIMITED_TIME"
},
"bonuses": [
{
"bonusCode": "",
"minimumQuantity": "",
"maximumQuantity": "",
"resultAmount": 0
}
]
}
]400
// Bad request
{
"errors": [
{
"code": "",
"fieldName": "",
"message": "",
"messageParameters": [
{}
]
}
]
}401
// Unauthorized
403
// Forbidden
500
// Internal error