Find Redemption Rewards
1 min
GET
https://api.b.preview.loyaltyservices.io/api/v3/rewards/redemption-rules
Query Parameters
- memberIdentifierstringDescriptionMin Length1Max Length200
- codestringDescriptionMin Length1Max Length30
- typeCodestringDescription
Responses
200
- FindRedemptionRewardsResponse
- redemptionRewardsRedemptionReward[]
- codestringExampleDescription
- typeCodestringExampleDescription
- descriptionstringExampleDescription
- currencyRequirednumberExampleDescription
- minimumQuantityinteger<int32>ExampleDescriptionFormatint32
- maximumQuantityinteger<int32>ExampleDescriptionFormatint32
- redeemIncrementinteger<int32>ExampleDescriptionFormatint32
- faceValuenumberExampleDescription
- amountProvidedbooleanDescription
- companyCodestringDescription
- sortValuestringDescription
- rewardContextRedemptionRewardContext
- redeemablebooleanDescription
- poolRedeemablebooleanDescription
- redeemTextstringExampleDescription
- requireAddressbooleanDescription
- requirePartnerAccountNumberbooleanDescription
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/rewards/redemption-rules \
--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/rewards/redemption-rules", 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/rewards/redemption-rules")
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/rewards/redemption-rules"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// Success
{
"redemptionRewards": [
{
"code": "GOLD_REWARD_2026",
"typeCode": "I = Item, T = Travel",
"description": "Gold Member Exclusive Reward",
"currencyRequired": 5000,
"minimumQuantity": 1,
"maximumQuantity": 10,
"redeemIncrement": 1,
"faceValue": 500,
"amountProvided": false,
"companyCode": "",
"sortValue": "",
"rewardContext": {
"redeemable": false,
"poolRedeemable": false,
"redeemText": "Click to Redeem",
"requireAddress": false,
"requirePartnerAccountNumber": false
}
}
]
}400
// Bad request
{
"errors": [
{
"code": "",
"fieldName": "",
"message": "",
"messageParameters": [
{}
]
}
]
}401
// Unauthorized
403
// Forbidden
500
// Internal error