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
Additional Attributes
Additional Transaction Journal Attributes Output
Applied Cart Line Promotion Details
Applied Cart Promotion Details
Badge
Cart
Cart Details
Cart Line Details
Club Member Benefits
Club Member Details
Club Member Enrollment Details
Club Member Promotions
Club Membership Renewal
Corporate Member Enrollment
Coupon Usage
Coupon Usage Result
Clone Promotion
Credit Points Action
Debit Points Action
Discount Details
Eligible Promotions List
Eligible Loyalty Tiers
Events Detail
Expression
Expression Value
Game Assignment
Game Details
Game Details (Promotion)
Game Result
Game Reward Details
Game Rewards List
Games List
Issue Voucher Action
Individual Member Enrollment
Link Program Member Partner
Loyalty Account
Loyalty Engine Realtime
Loyalty Contact
Loyalty Process
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
Member Benefit
Member Currency
Member Currency Change
Member Engagement Trail Output
Member Engagement Attribute
Member Points Balance
Member Profile
Member Currency
Member Tier
Member Points Balance Change
Name And Id
Participant Game Rewards List
Process Result
Points Change
Points Summary
Product Details
Promotion Configuration
Promotion Coupon Availability
Promotion Coupon
Promotion Details
Promotion Eligibility
Promotion Eligible Channel
Promotion Eligible Enrollment Period
Promotion Details
Promotion Enrollment
Enrollment Details
Enrollment Details for Eligible Promotions
Account Identifier
Contact Identifier
Offer Identifier
Promotion Identifier
Promotion Limit
Promotion Limit
Promotion
Promotion Recommendations
Promotion Reward Application
Promotion Reward Details
Promotion Rule
Promotion Rules List
Rule Action
Rule Action Parameter
Rule Condition
Rule Filter Criteria
Rule Library
Rule Parameter
Recommendation Details
Redeem Voucher
Summary
Template Configuration
Template List Configuration
Transaction Journal Details
Transaction Details
Transaction Journal
Transaction Journal Map
Transaction Journal Result
Transaction Journal Process Result
Transaction Ledgers
Update Cumulative Usage Action
Unified Promotions
Unified Promotion Templates
Unlink Program Member Partner
Voucher
Voucher Details
Vouchers List
Voucher Result
Voucher
Loyalty Management Connect API Interchangeable Request Fields
StandardValueSet Names and Standard Picklist Fields for Loyalty Management
Response Bodies
Here’s a list of Loyalty Management API response bodies.
-
Additional Attributes
Output representation of the additional details of a promotion. -
Additional Transaction Journal Attributes Output
Output representation of the additional transaction journal fields. -
Applied Cart Line Promotion Details
Specifies the list of cart line reward details. -
Applied Cart Promotion Details
The details of the cart-level promotions applied to the cart. -
Badge
Output representation of the badge assigned to a member. -
Cart
The details of a cart and its line items for which to evaluate and execute promotions. -
Cart Details
The details of the cart and its line items, including initial amount, adjusted price, and details of all applied discounts and promotions. -
Cart Line Details
The details of the initial amount, adjusted price, and details of all applied discounts and promotions to cart line items within the cart. -
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 representation of the corporate member enrollment create request. -
Coupon Usage
The details of the coupons for which usage has been increased or decreased. -
Coupon Usage Result
Represents the response for coupon usage increase and decrease POST method. -
Clone Promotion
Output representation of clone promotion request. -
Credit Points Action
Output representation of the credit points action type. -
Debit Points Action
Output representation of the debit points action type. -
Discount Details
The details of the discount applied to a customer's cart. -
Eligible Promotions List
Output representation of a list of eligible promotions. -
Eligible Loyalty Tiers
Output representation of the eligible loyalty tiers and tier groups of a promotion. -
Events Detail
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 representation of the details of a game assigned to a member. -
Game Details
Output representation of the details of a game definition. -
Game Details (Promotion)
The details of the game that's assigned to the customer. -
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 representation of the issue voucher action type. -
Individual Member Enrollment
Output representation of the individual member enrollment create request. -
Link Program Member Partner
Output representation of the program member and partner linkage request. -
Loyalty Account
Represents the details of the loyalty program member's associated account record. -
Loyalty Engine Realtime
Output representation of the loyalty program process result. -
Loyalty Contact
Represents the details of the loyalty program member's associated contact record. -
Loyalty Process
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 representation of all benefits available for a member. -
Member Benefit
Output representation of an individual benefit available for a member. -
Member Currency
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 representation of the details of a loyalty program member. -
Member Currency
Output representation of the member currency details. -
Member Tier
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 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 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 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 representation of the promotion eligibility criteria. -
Promotion Eligible Channel
Output representation of the eligible channel for a promotion. -
Promotion Eligible Enrollment Period
Output representation of the enrollment eligibility details of a promotion. -
Promotion Enrollment
Output representation of the request to enroll a customer in a promotion. -
Enrollment Details
Details of the enrolled customer, including the promotion party usage ID associated with the account. -
Enrollment Details for Eligible Promotions
The details of a customer’s enrollment in a promotion. -
Account Identifier
Details of the account enrolled in the promotion. -
Contact Identifier
Contact details of the account enrolled in the promotion. -
Offer Identifier
Details of the offer associated with the promotion enrollment. -
Promotion Identifier
Details of the promotion in which the customer is enrolled. -
Promotion Limit
Output representation of the promotion limit of an eligible promotion. -
Promotion Limit
Output representation of promotion limits. -
Promotion
Output representation of the promotion with rule configuration. -
Promotion Recommendations
The count and list of promotions recommended for the member or customer. -
Promotion Reward Application
Output representation details of the transaction journals that are created and processed. -
Promotion Reward Details
Output representation of the details of the reward offered by an eligible promotion rule. -
Promotion Rule
Output representation of the details of a promotion rule. -
Promotion Rules List
Output representation of an eligible promotion rule. -
Rule Action
Output representation of the details of a promotion rule action. -
Rule Action Parameter
Output representation of the details of a promotion rule action parameter. -
Rule Condition
Output representation of the details of a promotion rule condition. -
Rule Filter Criteria
Output representation of the details of a promotion rule filter criteria. -
Rule Library
The details of the rule library associated with the promotion. -
Rule Parameter
Output representation of the details of a promotion rule parameter. -
Recommendation Details
The rank and details of the recommended promotions. -
Redeem Voucher
Represents the response for the redeem voucher POST method. -
Summary
Output representation of the execution summary of the transaction journals. -
Template Configuration
Output representation of the template configuration. -
Template List Configuration
The output representation of the list template configuration -
Transaction Journal Details
The details of the transaction journal that's created. -
Transaction Details
Output representation of the transaction journal ledger records. -
Transaction Journal
Output representation of the transaction journals. -
Transaction Journal Map
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 representation of the transaction journals and the ledgers associated with the specified loyalty program member. -
Update Cumulative Usage Action
Output representation of the update cumulative usage action type. -
Unified Promotions
Output representation of the promotion details. -
Unified Promotion Templates
The output representation of the request to create a promotion. -
Unlink Program Member Partner
Output representation of the program member and partner unlink request. -
Voucher
Output representation of the details of a voucher. -
Voucher Details
The details of the voucher that's issued to the customer. -
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 representation of the details about a voucher.