Introduction
The Loyalty Rewards API allows you to manage rewards that customers can redeem with their loyalty points.For example, you can create a reward that is redeemed for a coupon for free shipping or for a coupon with a discount that applies to an entire purchase.
With the Loyalty Rewards API, you can create and update the rewards you offer.
Terminology
- Discount amount: A flexible reward type which allows to redeem points and get discount inside a checkout.
- Coupon reward: All other types of rewards other than “discount amount.” The details included here dictate what type of coupon will be created when this reward is redeemed.
A loyalty reward is an object a customer can redeem with loyalty points. Redeeming a reward then creates a loyalty coupon that the customer can use.
- DISCOUNT_AMOUNT: Discount reward. Special flexible reward type used in checkout.
- COUPON_REWARD: Coupon reward. Learn more about coupons.
- COUPON: Deprecated. Use COUPON_REWARD instead.
ONE OF:
Retrieves a list of rewards.
The list includes rewards that are currently nonredeemable due to insufficient points held by any customers.
Permission Scopes
For app development, you must have one of the following permission scopes:Creates a reward that can be redeemed with loyalty points.
When a customer redeems a reward, a loyalty coupon is created
based on the specifications detailed in either the discountAmount
or couponReward
fields. This coupon can
then be used by the customer to receive the discount. Note that while the Rewards API uses coupon scopes and specifications,
no coupon is actually created until a reward is redeemed with points.
See the Coupons API for more information about coupons. The type
of reward
cannot be updated.
A reward's active
status defaults to false
. To make the reward available to customers,
either set the active
field to true
during creation or call Update Reward
to change the status.
To customize a reward for each loyalty tier, use the configsByTier
parameter.
This allows you to specify the amount of the earned discount, the cost in loyalty points
to redeem the reward, and the tier to which this configuration applies. Each tier requires its own
configsByTier
configuration. To create a reward that is available to loyalty accounts in the base tier,
leave the tierId
field empty. See the Tiers API for more information on tiers.
Permission Scopes
For app development, you must have one of the following permission scopes:Retrieves a reward.
Permission Scopes
For app development, you must have one of the following permission scopes:Deletes a reward.
Permission Scopes
For app development, you must have one of the following permission scopes:Updates a loyalty reward.
Use this endpoint to update details of a reward, such as the name, whether or not a reward is active, or the amount of points it costs to redeem. Also use this endpoint to add new tiers that are eligible to redeem a reward.
You may not change the type
of a reward. That is set upon creation and cannot be updated.
Permission Scopes
For app development, you must have one of the following permission scopes:Triggered when a reward is created.
Permission Scopes
For app development, you must have one of the following permission scopes:Triggered when a reward is updated.
Permission Scopes
For app development, you must have one of the following permission scopes:Triggered when a reward is deleted.