Loyalty Management Developer Guide
jSummer '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)
CdpBasedLoyaltyPromotionInput Class
ChangeTierInput Class
IssueVoucherInput Class
LoyaltyPromotionInput Class
MemberPointBalanceInput Class
MemberTierInput Class
PointsInput Class
TransferMemberPointsToGroupsInput Class
Newer Version Available
LoyaltyManagement Namespace
The LoyaltyManagement
namespace provides Apex classes and methods to run the Loyalty Management
actions.
Use the developer console to invoke these classes and methods. For more information, see Open the Developer Console.
The following are the classes in the LoyaltyManagement namespace.
-
CdpBasedLoyaltyPromotionInput Class
Use this class to retrieve promotions that are eligible for a member based on the member’s market segment. This class receives the input parameter values for the Salesforce Customer Data Platform (CDP) based Loyalty Promotion action. -
CdpBasedLoyaltyPromotionInputBuilder Class
Contains methods to build an instance of the LoyaltyManagement.CdpBasedLoyaltyPromotionInput class. -
CdpBasedLoyaltyPromotionOutput Class
Represents the promotion records that the member is eligible for based on the member's market segment. -
ChangeTierInput Class
Use this class to change the tier for a given loyalty program member. This class receives the input parameter values for the Change Tier action. -
ChangeTierInputBuilder Class
Contains methods to build an instance of the LoyaltyManagement.ChangeTierInput class. -
ChangeTierOutput Class
Represents the changed tier details for a loyalty program member. -
CreditPointsOutput Class
Represents the details of points credited to a loyalty program member’s balance. -
DebitPointsOutput Class
Represents the details of points debited from a loyalty program member’s balance. -
IssueVoucherInput Class
Use this class to issue a voucher to a loyalty program member. This class receives the input parameter values for the Issue Voucher action. -
IssueVoucherInputBuilder Class
Contains methods to build an instance of the LoyaltyManagement.IssueVoucherInput class. -
IssueVoucherOutput Class
Represents the voucher ID issued to a loyalty program member. -
LoyaltyActionError Class
A class that contains the errors related to the execution of a Loyalty Management action. -
LoyaltyActionResult Class
A class that contains the result returned by a loyalty action. -
LoyaltyPromotionInput Class
Use this class to retrieve active promotions that are eligible for a transaction journal. The action can process accrual or redemption transactions. This class receives the input parameter values for the Loyalty Promotion action. -
LoyaltyPromotionInputBuilder Class
Contains methods to build an instance of the LoyaltyManagement.LoyaltyPromotionInput class. -
LoyaltyPromotionOutput Class
Represents the active promotions based on the specified transaction journal. -
LoyaltyResources Class
A class that executes a loyalty action and returns a result. Takes the input classes as input and returns the objects of output classes. -
MemberPointBalanceInput Class
Use this class to retrieve loyalty points balance for a given loyalty program member. This class receives the input parameter values for the Get Member Points action. -
MemberPointBalanceInputBuilder Class
Contains methods to build an instance of the LoyaltyManagement.MemberPointsBalanceInput class. -
MemberPointBalanceOutput Class
Represents the loyalty points balance for a specified loyalty program member. -
MemberTierInput Class
Use this class to retrieve the current tier for a specified loyalty program member. This class receives the input parameter values for the Get Member Tier action. -
MemberTierInputBuilder Class
Contains methods to build an instance of the LoyaltyManagement.MemberTierInput class. -
MemberTierOutput Class
Represents the tier details for a specified loyalty program member. -
PointsInput Class
Use this class to credit loyalty points to a loyalty program member’s balance or debit loyalty points from a loyalty program member’s balance. This class receives the input parameter values for the Credit and Debit point actions. -
PointsInputBuilder Class
Contains methods to build an instance of the LoyaltyManagement.PointsInput class. -
TransferMemberPointsToGroupsInput Class
Use this class to transfer points from an individual member or a corporate member to the member's associated group. This class receives the input parameter values for the Transfer Member Points To Groups action. -
TransferMemberPointsToGroupsInputBuilder Class
Contains methods to build an instance of the LoyaltyManagement.TransferMemberPointsToGroupsInput class. -
UpdateCumulativeUsageCompletedInput Class
Use this class to update the progress made by a loyalty program member towards attaining a Cumulative type promotion. The action creates a Loyalty Program Member Promotion record if the promotion isn't associated with the member. This class receives the input parameter values for the Update Cumulative Usage Completed action. -
UpdateCumulativeUsageCompletedOutput Class
Represents the details of the progress made by a loyalty program member towards attaining a Cumulative type promotion.