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.
Loyalty coupon ID.
Loyalty account ID of the customer that redeemed points for a coupon.
Member ID of the customer that redeemed points for a coupon.
Member ID of the customer that redeemed points for a coupon.
Transaction ID for the transaction that created a coupon.
Reference coupon information for the corresponding coupon that is created along with the loyalty coupon.
Loyalty coupon status.
This status relates to the corresponding coupon that is created
at the same time as the loyalty coupon and is included in couponReference
.
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.Name of reward that was redeemed to create this coupon.
Revision number, which increments by 1 each time the loyalty coupon is updated.
To prevent conflicting changes, the current revision
must be passed when updating the loyalty coupon.
Date and time the loyalty coupon was created.
Date and time the loyalty coupon was last updated.