Find Redemption Rules
1 min
GET
https://api.b.preview.loyaltyservices.io/api/v3/redemption-rules
Query Parameters
- externalCodestringDescriptionMin Length1Max Length30
- pageNumberintegerDescriptionDefault1Minimum1
- pageSizeintegerDescriptionMinimum1
Responses
200
- FindRedemptionRulesResponse
- redemptionRulesRedemptionRule[]
- idinteger<int64>DescriptionFormatint64
- codestringrequiredExampleDescriptionMin Length1Max Length30
- externalCodestringExampleDescriptionMin Length1Max Length30
- descriptionstringrequiredExampleDescriptionMin Length1Max Length100
- statusCodestringDescriptionDefaultA
- startDatestring<date>requiredExampleDescriptionFormatdate
- endDatestring<date>ExampleDescriptionFormatdate
- redemptionTypeCodestringrequiredExampleDescription
- rankinteger<int32>ExampleDescriptionDefault1Formatint32
- redeemablebooleanExampleDescriptionDefaulttrue
- workflowStatusstringDescriptionDefaultWORKING
- rawExpressionstringDescription
- faceValuenumberExampleDescription
- dataReleaseinteger<int64>DescriptionFormatint64
- partnerCodestringDescription
- minimumRoleRequiredinteger<int64>DescriptionFormatint64
- quantitiesRedemptionRuleQuantitiesrequired
- pointCategoryCodestringrequiredExampleDescriptionDefaultPOINTS
- amountProvidedbooleanrequiredDescriptionDefaultfalse
- pointsRequirednumberExampleDescription
- providedAmountRatenumberExampleDescription
- minimumQuantityinteger<int32>requiredExampleDescriptionDefault1Formatint32
- maximumQuantityinteger<int32>DescriptionFormatint32
- redeemIncrementinteger<int32>ExampleDescriptionFormatint32
- fulfillmentRedemptionRuleFulfillment
- fulfillmentPathCodestringrequiredExampleDescription
- communicationTypeCodestringExampleDescription
- couponAwardstringDescription
- redemptionRuleBonusCodestringDescription
- merchantstringDescriptionMax Length50
- contentstringDescriptionMax Length50
- pageInfoPageInfo
- numberintegerDescription
- sizeintegerDescription
- totalItemsintegerDescription
- hasNextbooleanDescription
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-rules?pageNumber=1' \
--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-rules?pageNumber=1", 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-rules?pageNumber=1")
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-rules?pageNumber=1"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// Success
{
"redemptionRules": [
{
"id": "",
"code": "GOLD_REWARD_2026",
"externalCode": "GOLD_REWARD",
"description": "Gold Member Exclusive Reward",
"statusCode": "",
"startDate": "2025-01-01",
"endDate": "2050-12-31",
"redemptionTypeCode": "I = Item, T = Travel",
"rank": 10,
"redeemable": true,
"workflowStatus": "",
"rawExpression": "",
"faceValue": 500,
"dataRelease": "",
"partnerCode": "",
"minimumRoleRequired": "",
"quantities": {
"pointCategoryCode": "POINTS",
"amountProvided": false,
"pointsRequired": 5000,
"providedAmountRate": 100,
"minimumQuantity": 1,
"maximumQuantity": "",
"redeemIncrement": 1
},
"fulfillment": {
"fulfillmentPathCode": "COUPON",
"communicationTypeCode": "RedemptionConfirmationEmail",
"couponAward": "",
"redemptionRuleBonusCode": "",
"merchant": ""
},
"content": ""
}
],
"pageInfo": {
"number": 0,
"size": 0,
"totalItems": 0,
"hasNext": false
}
}400
// Bad request
{
"errors": [
{
"code": "",
"fieldName": "",
"message": "",
"messageParameters": [
{}
]
}
]
}401
// Unauthorized
403
// Forbidden
500
// Internal error