Loyalty
Track Achievement Progress
Records progress towards a custom Achievement for a Loyalty Customer. Use a progress type of `delta` to add to or subtract from the existing progress, or `exact` to set it to an absolute value.
List Active Coupons
Lists the active coupons for a customer. If a Loyalty Customer is specified, this returns the most recent coupons that have not been used for that customer.
Retrieve a Loyalty Customer
Returns basic details about a Loyalty Customer, including their status, points balance and VIP Tier.
Activate a Loyalty Customer
Enrols a Customer into the loyalty program. The version of the legal policies the Customer accepted must be provided.
List Earning Rules
Lists the available ways to earn rewards for performing actions. Each earning rule awards either loyalty points, a coupon, or store credit. If points are earned, these can then be exchanged for a coupon or store credit via a redemption rule. If a Loyalty Customer is specified, this returns ways of earning and reward amounts tailored to that customer.
List Redemption Rules
Lists the available ways to redeem loyalty points for rewards. If a Loyalty Customer is specified, this returns ways of redeeming and amounts tailored to that customer.
Adjust a Loyalty Customer's Points
Adds points to or removes points from a Loyalty Customer's points balance, and records the change as a transaction.
Set a Loyalty Customer's Minimum VIP Tier
Sets a minimum VIP Tier for a Loyalty Customer, optionally with an expiry date, or removes a previously configured one. The Customer's current VIP Tier may change as a result.
Trigger a Custom Earning Rule
Awards points to a Loyalty Customer by triggering a custom earning rule. For Custom Points Per Value rules, provide a value to multiply with the rule's points per value.
Redeem a Reward
Redeems a Loyalty Customer's points for a reward using a redemption rule. For variable rewards, provide the points and value being redeemed.