Get Available Manual Bonus Rules
1 min
GET
https://api.b.preview.loyaltyservices.io/api/v3/members/{memberIdentifier}/bonuses
Path Parameters
- memberIdentifierstringrequiredExampleDescriptionMin Length1Max Length200
Query Parameters
- typeCodestringExampleDescription
Responses
200
- BonusRule[]
- bonusRuleCodestringExampleDescription
- bonusRuleDescriptionstringExampleDescription
- bonusRuleTypeDescriptionstringExampleDescription
- rewardCurrencyCategoryDescriptionstringExampleDescription
- rewardCurrencyTypeDescriptionstringExampleDescription
- rewardCurrencyAmountnumberExampleDescription
- bonusPointInstanceLimitnumberExampleDescription
- billablebooleanExampleDescription
- billableToTypeCodeinteger<int64>ExampleDescriptionFormatint64
- startDatestring<date>DescriptionFormatdate
- endDatestring<date>DescriptionFormatdate
- graceLimitinteger<int32>DescriptionFormatint32
- rewardsRuleReward[]Description
- rewardTypestring<COUNTER | CURRENCY | COUPON | BADGE | TIER | FUTURE_TIER | PROMOTION | REDEMPTION | COMMUNICATION | SEGMENT>requiredExampleDescriptionAllowedCOUNTERCURRENCYCOUPONBADGETIERFUTURE_TIERPROMOTIONREDEMPTIONCOMMUNICATIONSEGMENT
- rewardResultTypestringExampleDescription
- descriptionstringExampleDescription
- codestringExampleDescription
- amountnumberExampleDescription
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}/bonuses \
--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}/bonuses", 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}/bonuses")
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}/bonuses"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// Success
[
{
"bonusRuleCode": "Adjustment1000",
"bonusRuleDescription": "Adjustment Bonus 1000 Points",
"bonusRuleTypeDescription": "Enrollment Bonus",
"rewardCurrencyCategoryDescription": "Loyalty",
"rewardCurrencyTypeDescription": "Provided",
"rewardCurrencyAmount": 500,
"bonusPointInstanceLimit": 200,
"billable": true,
"billableToTypeCode": 23200,
"startDate": "",
"endDate": "",
"graceLimit": "",
"rewards": [
{
"rewardType": "COUNTER",
"rewardResultType": "Provided",
"description": "Tier Qualifying Nights",
"code": "NIGHTS",
"amount": 10
}
]
}
]400
// Bad request
{
"errors": [
{
"code": "",
"fieldName": "",
"message": "",
"messageParameters": [
{}
]
}
]
}401
// Unauthorized
403
// Forbidden
500
// Internal error