What are rewards?
Rewards are the various options that members get to redeem their points on. For instance, $10 OFF for 1000 points, Free Shipping for 1000 points, Free Water Bottle for 500 points, and so on.
Every reward redemption activity creates point debit transactions. The transactions created against rewards will contain the data for the various transaction attributes defined in the reward setting. The reward object will contain the attributes that define the reward settings- 'how many points to redeem, reward name, reward ID (redemption ID), text configuration', which member segments to enable the reward; and custom transaction attributes .
A sample JSON of the reward object is shown below.
{
"id" : "5087ffaabbccy677ffc7995f",
"reward_id" : "$5_OFF",
"reward_name" : "$5 OFF",
"is_active" : "True",
"reward_type" : "coupon_based_reward",
"reward_sub_type" : "fixed_amount_discount",
"show_on_guest_dashboard": "True",
"reward_card_background_image_url" : "https://d1qbqkkh49kht1.cloudfront.net/fb112084ec96f50e717a86bb8d52d589.png",
"enduser_reward_short_description" : "$5 OFF for 500 points",
"enduser_reward_confirmation_html" : "<div> 500 points will be redeemed from your account balance and you will receive a $5 OFF coupon.<br> Do you wish to confirm?.</div>",
"enduser_reward_post_confirmation_html" : "<div> 500 points have been redeemed. Here is your coupon code. <br> Copy this code and use it on checkout..</div>",
"points_to_be_redeemed" : "500",
"reward_value" : "$5",
"coupons_info" : {
"total_coupons" : "102",
"issued_coupons" : "4",
"redeemed_coupons" : "0",
"coupons" : "[‘XVFDGT56RT’, ‘XVFDGT90UT’, ‘XVFDGT89GH’, ‘XVFDGT78EW’, …."]
},
"member_eligibility_rules": [ {
"show_on_member_dashboard" : "True",
"include_in_api_response" : "False",
"conditions" : [
{
"operator" : "Between",
"attribute" : "Enrolment Date",
"value" : "11/1/2021-2/28/2023",
},
"AND",
{
"operator" : "Contain all of",
"attribute" : "User Tags",
"value" : ["cohortA"],
},
]
},
{
"show_on_member_dashboard" : "True",
"include_in_api_response" : "False",
"conditions" : [
{
"operator" : "Contain all of",
"attribute" : "User Tags",
"value" : ["cohortC", "cohortD"],
}
]
}
],
"custom_transaction_attributes" : [
{
"attribute_name" : "Source Of Redemption",
"attribute_type" : "Text",
"attribute_id" : "source_of_redemption",
"is_attribute_mandatory" : "False",
}
]
"last_modified_date" : "12/29/2021 16:47:40",
"created_date" : "10/13/2019 01:47:40",
}
The reward resource will have the following API endpoints:
- Retrieve a reward
- List all rewards
- List all the rewards a member is eligible for