Introduction

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.

Retrieves a list of rewards.

Only rewards with "active" set to "true" will be retrieved. The list includes rewards that are currently unredeemable due to insufficient points held by any customers.

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.

Retrieves a reward.

Deletes a reward.

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.

Triggered when a reward is created.

Triggered when a reward is updated.

Triggered when a reward is deleted.