A loyalty coupon is created when a customer redeems their loyalty points for a reward. Creating a loyalty coupon also creates a corresponding "reference" coupon with the Coupons API.
- ACTIVE: The reference coupon is active and available to the customer.
- APPLIED: The reference coupon was applied and is no longer available for use.
- ARCHIVED: The reference coupon was deleted.
- FAILED: The reference coupon was created but something went wrong when redeeming points from the loyalty account.
- PENDING: The refence coupon was created but the loyalty points have not been redeemed yet.
Redeems a customer's loyalty points for a loyalty reward and creates a loyalty coupon.
Creating a loyalty coupon also creates a corresponding "reference" coupon with the Coupons API.
The customer receives the reference coupon, which they can apply to their order. The loyalty coupon and its corresponding reference coupon
are linked and the loyalty coupon's status
reflects the current state of the reference coupon.
Check which loyalty rewards a site has available with List Rewards.
Redeems a current customer's loyalty points for a loyalty reward and creates a loyalty coupon.
Creating a loyalty coupon also creates a corresponding "reference" coupon with the Coupons API.
The customer receives the reference coupon, which they can apply to their order. The loyalty coupon and its corresponding reference coupon
are linked and the loyalty coupon's status
reflects the current state of the reference coupon.
Check which loyalty rewards a site has available with List Rewards.
Retrieves a loyalty coupon.
Permission Scopes
For app development, you must have one of the following permission scopes:Retrieves the loyalty coupons for the currently logged-in member.
Permission Scopes
For app development, you must have one of the following permission scopes:Retrieves a list of loyalty coupons, given the provided paging, filtering, and sorting.
Permission Scopes
For app development, you must have one of the following permission scopes:Deletes a loyalty coupon.
The deletion of a loyalty coupon does not impact the functionality of the corresponding coupon itself.
Permission Scopes
For app development, you must have one of the following permission scopes:Triggered when a loyalty coupon is created.
Permission Scopes
For app development, you must have one of the following permission scopes:Triggered when a loyalty coupon is deleted.