Loyalty Management Developer Guide
Summer '26 (API version 67.0)
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Coupon Objects in Loyalty Management
Club Member Enrollment
Club Member Profile
Club Membership Renewal
Corporate Member Enrollments
Individual Member Enrollments
Member Benefits
Member Profile
Member Engagement Trail
Member Vouchers
Redeem Voucher
Transaction History
Transaction Ledger Summary
Transaction Journals Execution
Transaction Journals Simulation
Loyalty Management Connect API Interchangeable Request Fields
Newer Version Available
Resources
Here’s a list of Loyalty Management API resources.
-
Club Member Enrollment
Enroll members in a club and manage their details, including membership numbers, renewal periods, and end dates. -
Club Member Profile
Get the profile details of a club member such as membership number, contact ID, and loyalty program name. -
Club Membership Renewal
Renew the membership of club members and manage their membership details such as membership numbers, renewal periods, and end dates. -
Corporate Member Enrollments
Enroll corporate members in a loyalty program. Create a business account and a Corporate type loyalty program member record for the new member. -
Individual Member Enrollments
Enroll individual members in a loyalty program. Create a person account and an Individual type loyalty program member record for the new member. -
Member Benefits
Get benefits for a loyalty program member. -
Member Profile
Get the details of a loyalty program member. -
Member Engagement Trail
Fetches current and target values of the milestones defined in an engagement trail and the rewards received after achieving milestones. -
Member Vouchers
Get vouchers that have been issued to a loyalty program member. -
Redeem Voucher
Redeem a voucher for a loyalty program member. The status of the voucher gets updated to redeemed and the use date gets updated to the current date. -
Transaction History
Get transaction journals of a loyalty member belonging to a loyalty program. Obtain either accrual or redemption transaction journal records. -
Transaction Ledger Summary
Retrieve an aggregate view on the transaction journal and the loyalty ledger records. -
Transaction Journals Execution
Use this resource to create and process a list of transaction journals against a corresponding loyalty program process. -
Transaction Journals Simulation
Runs a simulation to determine how transaction journals are processed against their corresponding loyalty program processes. When transaction journals meet the criteria and conditions for a program process, actions that are set up in the process are triggered for the transaction journals. -
Loyalty Program Process
Run a loyalty process created from a loyalty program process template. -
Gamification
Who doesn’t like to play a game? Engage your customers more by gamifying customer activities, such as placing an order, or events, such as birthdays and anniversaries. -
Promotion
The promotion APIs allow you to set eligibility rules and limits for a promotion, choose a promotion template, and create a promotion. You can also get the details of a specific promotion, and view a list of eligible promotions for a customer’s cart.