Loyalty Management Developer Guide
jSummer '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)
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Coupon Objects in Loyalty Management
Additional Attributes Output
Additional Transaction Journal Attributes Output
Badge Output
Club Member Benefits
Club Member Details
Club Member Enrollment Details
Club Member Promotions
Club Membership Renewal
Corporate Member Enrollment Output
Coupon Availablity Message
Coupon Usage Result
Clone Promotion Output
Credit Points Action Output
Debit Points Action Output
Eligible Promotions List
Eligible Loyalty Tiers Output
Events Detail Output
Expression
Expression Value
Game Assignment Output
Game Details
Game Result
Game Reward Details
Game Rewards List
Games List
Issue Voucher Action Output
Individual Member Enrollment Output
Loyalty Account Output
Loyalty Engine Realtime Output
Loyalty Contact Output
Loyalty Process Output
Loyalty Program Process Rule
Loyalty Program Process Rule Step
Loyalty Program Process Rule Action
Loyalty Program Process Rule Action Parameter
Loyalty Program Process Rule Condition
Loyalty Program Process Rule Condition Filter Criteria
Loyalty Program Process Rule Condition Group
Loyalty View Transaction Journal History Output
Member Benefits Output
Member Benefit Output
Member Currency Output
Member Currency Change
Member Engagement Trail Output
Member Engagement Attribute
Member Points Balance
Member Profile Output
Member Currency
Member Tier Output
Member Points Balance Change
Name And Id Output
Participant Game Rewards List
Process Result
Points Change Output
Points Summary
Product Details
Promotion Configuration Output
Promotion Coupon Availability
Promotion Coupon
Promotion Details
Promotion Eligibility Output
Promotion Eligible Channel Output
Promotion Eligible Enrollment Period Output
Promotion Details
Promotion Limit
Promotion Limit Output
Promotion Recommendations
Promotion Reward Details
Promotion Rules List
Recommendation Details
Redeem Voucher Output
Summary
Transaction Details Output
Transaction Journal Output
Transaction Journal Map Output
Transaction Journal Result
Transaction Journal Process Result
Transaction Ledgers Output
Update Cumulative Usage Action Output
Unified Promotions Output
Voucher
Vouchers List
Voucher Result
Voucher Output
Loyalty Management Connect API Interchangeable Request Fields
Response Bodies
Here’s a list of Loyalty Management API response bodies.
-
Additional Attributes Output
The output representation of the additional details of a promotion. -
Additional Transaction Journal Attributes Output
Output representation of the additional transaction journal fields. -
Badge Output
Output representation of the badge assigned to a member. -
Club Member Benefits
Represents the output for Club Member Benefits. -
Club Member Details
Represents the output for Club Member Profile API. -
Club Member Enrollment Details
Represents the output for Club Member Enrollment API. -
Club Member Promotions
Represents the output for Club Member Promotions. -
Club Membership Renewal
Represents the output for Club Membership Renewal API. -
Corporate Member Enrollment Output
Output representation of the corporate member enrollment create request. -
Coupon Availablity Message
Output representation of the coupon availability message. -
Coupon Usage Result
Represents the response for coupon usage increase and decrease POST method. -
Clone Promotion Output
Output representation of Clone Promotion API. -
Credit Points Action Output
Output representation of the credit points action type. -
Debit Points Action Output
Output representation of the debit points action type. -
Eligible Promotions List
Output representation of a list of eligible promotions. -
Eligible Loyalty Tiers Output
Output representation of the eligible loyalty tiers and tier groups of a promotion. -
Events Detail Output
Output representation of the customer event eligible for a promotion. -
Expression
Output representation of the expression. -
Expression Value
Output representation of the expression value. -
Game Assignment Output
Output representation of the details of a game assigned to a member. -
Game Details
Output representation of the details of a game definition. -
Game Result
Output representation of the game reward that a participant has won. -
Game Reward Details
Output representation of the details of the game reward that a participant has won. -
Game Rewards List
Output representation of the details of a possible game reward. -
Games List
Output representation of the list of games assigned to a member. -
Issue Voucher Action Output
Output representation of the issue voucher action type. -
Individual Member Enrollment Output
Output representation of the individual member enrollment create request. -
Loyalty Account Output
Represents the details of the loyalty program member's associated account record. -
Loyalty Engine Realtime Output
Output representation of the loyalty program process result. -
Loyalty Contact Output
Represents the details of the loyalty program member's associated contact record. -
Loyalty Process Output
Output representation of the loyalty process response. -
Loyalty Program Process Rule
Output representation of the loyalty program process rules. -
Loyalty Program Process Rule Step
Output representation of the loyalty program process rule step. -
Loyalty Program Process Rule Action
Output representation of the loyalty program process rule action. -
Loyalty Program Process Rule Action Parameter
Output representation of the loyalty program process rule action parameter. -
Loyalty Program Process Rule Condition
Output representation of the loyalty program process rule condition. -
Loyalty Program Process Rule Condition Filter Criteria
Output representation of the loyalty program process rule condition filter criteria. -
Loyalty Program Process Rule Condition Group
Output representation of the loyalty program process rule condition group. -
Loyalty View Transaction Journal History Output
Output representation of the view transaction history request. -
Member Benefits Output
Output representation of all benefits available for a member. -
Member Benefit Output
Output representation of an individual benefit available for a member. -
Member Currency Output
Represents the details of the loyalty program member's associated currencies. -
Member Currency Change
Output representation of the member currency change. -
Member Engagement Trail Output
Output representation of member engagement trail API. -
Member Engagement Attribute
Ouput representation of Member Engagement Attribute. -
Member Points Balance
Output representation of the member currency result. -
Member Profile Output
Output representation of the details of a loyalty program member. -
Member Currency
Output representation of the member currency details. -
Member Tier Output
Represents the details of the loyalty program member's associated tiers. -
Member Points Balance Change
Output representation of the points balance change for a member. -
Name And Id Output
Output representation of an object’s name and ID. -
Participant Game Rewards List
Output representation of the participant game reward object. -
Process Result
Output representation of results of the processed Transaction Journals records. -
Points Change Output
Output representation of the points debited from or credited to the member's points balance by the transaction journal. -
Points Summary
Output representation of the point summary. -
Product Details
The details of a product associated with the recommended promotion. -
Promotion Configuration Output
Output representation of the promotion’s details and its configuration. -
Promotion Coupon Availability
Output representation of the promotion coupon availability. -
Promotion Coupon
Output representation of the promotion coupon. -
Promotion Details
Output representation of the details of an eligible promotion. -
Promotion Eligibility Output
Output representation of the promotion eligibility criteria. -
Promotion Eligible Channel Output
Output representation of the eligible channel for a promotion. -
Promotion Eligible Enrollment Period Output
Output representation of the enrollment eligibility details of a promotion. -
Promotion Limit
Output representation of the promotion limit of an eligible promotion. -
Promotion Limit Output
Output representation of promotion limits. -
Promotion Recommendations
The count and list of promotions recommended for the member or customer. -
Promotion Reward Details
Output representation of the details of the reward offered by an eligible promotion rule. -
Promotion Rules List
Output representation of an eligible promotion rule. -
Recommendation Details
The rank and details of the recommended promotions. -
Redeem Voucher Output
Represents the response for the redeem voucher POST method. -
Summary
Output representation of the execution summary of the transaction journals. -
Transaction Details Output
Output representation of the transaction journal ledger records. -
Transaction Journal Output
Output representation of the transaction journals. -
Transaction Journal Map Output
Output representation of the loyalty program process simulation result. -
Transaction Journal Result
Output representation of the transaction journals result. -
Transaction Journal Process Result
Output representation of the Transaction Journal result. -
Transaction Ledgers Output
Output representation of the transaction journals and the ledgers associated with the specified loyalty program member. -
Update Cumulative Usage Action Output
Output representation of the update cumulative usage action type. -
Unified Promotions Output
Output representation of the created, or updated promotion. -
Voucher
Output representation of the details of a voucher. -
Vouchers List
Output representation of the list of vouchers associated with the loyalty program member. -
Voucher Result
Output representation of the voucher result. -
Voucher Output
Output representation of the details about a voucher.