Engagement Hub API Documentation

ENGAGEMENT HUB API

Getting Started

Customer APIs

Loyalty APIs

Voucher APIs

Customer OnBoarding

{
“contactIds”:[“XXXXXXXXXXXXXXXXX”]
}

Code: 200

Content:

{
“statusMessage”: null,
“statusCode”: 200,
“profiles”: [
{
“totalPoints”: 0,
“tierRequiredPoints”: null,
“tierImg”: null,
“tier”: “default”,
“statusCode”: 201,
“startDate”: null,
“reservedPoints”: 0,
“redeemedPoints”: 0,
“nextTierRequiredPoints”: null,
“nextTierImg”: null,
“nextTier”: null,
“message”: null,
“id”: “XXXXXXXXXXXXXXXXX”,
“expiredPoints”: null,
“expirationDate”: null,
“customerProfession”: null,
“customerPhoto”: null,
“customerName”: null,
“customerId”: null,
“countryName”: null,
“contactId”: “XXXXXXXXXXXXXXXXX”,
“confirmedPoints”: 0,
“companyName”: null,
“code”: “CARD-XXXXXXX”,
“active”: null,
“accountId”: null
}
]
}

curl -X POST \
https://platform-nosoftware-5450.cs92.my.salesforce.com/services/apexrest/veloyalty/v1.0/voucher/create/ \
-H ‘authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx’ \
-d ‘[
{
“loyaltyId”:”XXXXXXXXXXXXXXXXX”,
“expirationDate”:”2021-03-29″,
“amount” :10
}

]
‘

Customer OffBoarding

{
“loyaltyIds”:[“XXXXXXXXXXXXXXXXX”]
}

Code: 200

Content:

{
“statusMessage”: “Ok”,
“statusCode”: 200,
“profiles”: [
{
“statusMessage”: “Customer removed from loyalty program”,
“statusCode”: 204,
“profileId”: “XXXXXXXXXXXXXXXXX”
}
]
}

curl -X POST \
https://platform-nosoftware-5450.cs92.my.salesforce.com/services/apexrest/veloyalty/v1.0/customer/offboard \
-H ‘authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx’ \
-d ‘{
“loyaltyIds”:[“XXXXXXXXXXXXXXXXX”]
}’

Customer AssignPoints

[
{
“issuedPoints”:30.0,
“loyaltyId”:”XXXXXXXXXXXXXXXXX”,
“type”:”Purchase points”,
“expirationType”:”Rolling expiration”
}
]

Code: 200

Content:

{
{
“statusMessage”: “point assigned”,
“statusCode”: 200,
“points”: [
{
“usedPoints”: null,
“type”: “Incidental points”,
“statusCode”: 200,
“source”: “web”,
“recalculated”: false,
“reason”: null,
“order”: null,
“message”: “points assigned”,
“loyaltyId”: “XXXXXXXXXXXXXXXXX”,
“issuedPoints”: 20,
“expiredPoints”: null,
“expirationType”: “Rolling expiration”,
“expirationDate”: null,
“earnedPointsId”: null,
“confirmed”: true,
“amount”: null,
“activePoints”: null
}
]
}

curl -X POST \
https://platform-nosoftware-5450.cs92.my.salesforce.com/services/apexrest/veloyalty/v1.0/loyaltypoints/assign/ \
-H ‘authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx’ \
-d ‘[
{
“issuedPoints”:20,
“loyaltyId”:”XXXXXXXXXXXXXXXXX”,
“type”:”Incidental points”,
“expirationType”:”Rolling expiration”
}

]
‘

Get Loyalty info

{
“loyaltyIds”:[“XXXXXXXXXXXXXXXXX”]
}

Code: 200

Content:

{
“statusMessage”: “Ok”,
“statusCode”: 200,
“loyaltyProfiles”: [
{
“statusMessage”: “Ok”,
“statusCode”: 200,
“profileId”: “XXXXXXXXXXXXXXXXX”,
“info”: {
“totalPoints”: 0,
“tierRequiredPoints”: null,
“tierImg”: null,
“tier”: “default”,
“statusCode”: null,
“startDate”: null,
“reservedPoints”: 0,
“redeemedPoints”: 0,
“nextTierRequiredPoints”: null,
“nextTierImg”: null,
“nextTier”: null,
“message”: null,
“id”: “XXXXXXXXXXXXXXXXX”,
“expiredPoints”: null,
“expirationDate”: null,
“customerProfession”: null,
“customerPhoto”: null,
“customerName”: null,
“customerId”: null,
“countryName”: null,
“contactId”: “XXXXXXXXXXXXXXXXX”,
“confirmedPoints”: 0,
“companyName”: null,
“code”: “CARD-XXXXXXX”,
“active”: null,
“accountId”: null
},
“benefits”: {}
}
]
}

curl -X POST \
https://platform-nosoftware-5450.cs92.my.salesforce.com/services/apexrest/veloyalty/v1.0/loyalty/info/ \
-H ‘authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx’ \
-d ‘{
“loyaltyIds”:[“XXXXXXXXXXXXXXXXX”]
}’

Redeem benefits

{
“loyaltyId”:”XXXXXXXXXXXXXXXXX”,
“Benefits”:[
{
“BenefitId”:”XXXXXXXXXXXXXXXXX”,
“TransactionId”:”orderTest”

}
]
}

Code: 200

Content:

{
“statusMessage”: “ok”,
“statusCode”: 200,
“loyaltyId”: “XXXXXXXXXXXXXXXXX”,
“benefits”: [
{
“transactionId”: “orderTest”,
“statusMessage”: “Ok”,
“statusCode”: 201,
“benefitId”: “XXXXXXXXXXXXXXXXX”
}
]
}

curl -X POST \
https://platform-nosoftware-5450.cs92.my.salesforce.com/services/apexrest/veloyalty/v1.0/benefit/redeem/ \
-H ‘authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx’ \
-d ‘{
“loyaltyId”:”XXXXXXXXXXXXXXXXX”,
“Benefits”:[

{“BenefitId”:”XXXXXXXXXXXXXXXXX”,
“TransactionId”:”orderTest”

}
]
}’

Get Vouchers

Create Voucher

[
{
“loyaltyId”:”XXXXXXXXXXX XXXXXX”,
“expirationDate”:”2021-03-29″,
“amount” :10
}

]

Code: 200

Content:

{
“vouchers”: [
{
“voucherValue”: null,
“voucherNumber”: null,
“voucherId”: null,
“statusCode”: 406,
“status”: null,
“oneTimeUse”: null,
“monetaryValue”: null,
“message”: “no enough points”,
“loyaltyId”: “XXXXXXXXXXXXXXXXX”,
“expirationDate”: “2021-03-29”,
“code”: null,
“amount”: 10,
“active”: null
}
],
“statusMessage”: “OK”,
“statusCode”: 200
}

Redeem Vouchers

{
“loyaltyId”:”XXXXXXXXXXXXXXXXX”,
“vouchers”:[
{
“voucherId”:”VOUCHER-XXXXXX”,
“transactionId”:”Test”
}
]
}

Code: 200

Content:

{
“statusMessage”: “ok”,
“statusCode”: 200,
“loyaltyId”: “XXXXXXXXXXXXXXXXX”,
“vouchers”: [
{
“transactionId”: “Test”,
“statusMessage”: “Ok”,
“statusCode”: 201,
“voucherId”: “VOUCHER-XXXXXX”
}
]
}

curl -X POST \
https://site-efficiency-9583.cs94.my.salesforce.com/services/apexrest/veloyalty/v1.0/voucher/redeem/ \
-H ‘authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx’ \
-d ‘{
“loyaltyId”:”XXXXXXXXXXXXXXXXX”,
“vouchers”:[
{
“voucherId”:”VOUCHER-XXXXXX”,
“transactionId”:”Test”
}
]
}’