Loyalty Management Developer Guide

Loyalty Management Standard Objects
Loyalty Management Fields on Standard Objects
Loyalty Management Associated Objects
Apex Reference
ConnectApi Namespace
LoyaltyManagement Namespace
CdpBasedLoyaltyPromotionInput Class
CdpBasedLoyaltyPromotionInputBuilder Class
CdpBasedLoyaltyPromotionOutput Class
ChangeTierInput Class
ChangeTierInputBuilder Class
ChangeTierOutput Class
CreditPointsOutput Class
DebitPointsOutput Class
GetMemberActiveSegmentsInput Class
GetMemberActiveSegmentsInputBuilder Class
GetMemberActiveSegmentsOutput Class
IssueVoucherInput Class
IssueVoucherInputBuilder Class
IssueVoucherOutput Class
LoyaltyActionError Class
LoyaltyActionResult Class
LoyaltyPromotionInput Class
LoyaltyPromotionInputBuilder Class
LoyaltyPromotionOutput Class
LoyaltyResources Class
MemberPointBalanceInput Class
MemberPointBalanceInputBuilder Class
MemberPointBalanceOutput Class
MemberTierInput Class
MemberTierInputBuilder Class
MemberTierOutput Class
PointsInput Class
PointsInputBuilder Class
PointsInputBuilder Methods
TransferMemberPointsToGroupsInput Class
TransferMemberPointsToGroupsInputBuilder Class
UpdateCumulativeUsageCompletedInput Class
UpdateCumulativeUsageCompletedOutput Class
Loyalty Management Business APIs
Loyalty Management Standard Invocable Actions
Loyalty Management Custom Invocable Actions
Loyalty Management Metadata API Types
Loyalty Management Tooling API Objects
Loyalty Management Mobile SDK
Gamification Mobile SDK
Data Processing Engine, Batch Management, and Monitor Workflow Services
StandardValueSet Names and Standard Picklist Fields for Loyalty Management
References
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

PointsInputBuilder Class

Contains methods to build an instance of the LoyaltyManagement.PointsInput class.

Namespace

LoyaltyManagement

PointsInputBuilder Methods

The following are methods for PointsInputBuilder.

build()

Returns an instance of the LoyaltyManagement.PointsInput object.

Signature

public LoyaltyManagement.PointsInput build()

Return Value

Type: LoyaltyManagement.PointsInput

setAdditionalNotes(additionalNotes)

Represents extra information about the transactions performed by the loyalty program member.

Signature

public LoyaltyManagement.PointsInputBuilder setAdditionalNotes(String additionalNotes)

Parameters

additionalNotes
Type: String

Return Value

Type: LoyaltyManagement.PointsInputBuilder

setCorrelationId(correlationId)

Represents the ID of any Salesforce entity.

Signature

public LoyaltyManagement.PointsInputBuilder setCorrelationId(String correlationId)

Parameters

correlationId
Type: String

Return Value

Type: LoyaltyManagement.PointsInputBuilder

setFlowId(flowId)

Represents the ID of the flow associated with the credit or debit points action.

Signature

public LoyaltyManagement.PointsInputBuilder setFlowId(String flowId)

Parameters

flowId
Type: String

Return Value

Type: LoyaltyManagement.PointsInputBuilder

setJournalId(journalId)

Represents the ID of the transaction journal. This is a required field.

Signature

public LoyaltyManagement.PointsInputBuilder setJournalId(String journalId)

Parameters

journalId
Type: String

Return Value

Type: LoyaltyManagement.PointsInputBuilder

setLoyaltyProgramMemberId(loyaltyProgramMemberId)

Represents the ID of the loyalty program member to whom the points must be credited or debited. This is a required field.

Signature

public LoyaltyManagement.PointsInputBuilder setLoyaltyProgramMemberId(String loyaltyProgramMemberId)

Parameters

loyaltyProgramMemberId
Type: String

Return Value

Type: LoyaltyManagement.PointsInputBuilder

setPoints(points)

Represents the points available with the loyalty program member. This is a required field.

Signature

public LoyaltyManagement.PointsInputBuilder setPoints(Double points)

Parameters

points
Type: Double

Return Value

Type: LoyaltyManagement.PointsInputBuilder

setPointsExpirationDate(pointsExpirationDate)

Represents the date on which fixed-model non-qualifying points credited by the action expire.

Signature

public LoyaltyManagement.PointsInputBuilder setPointsExpirationDate(String pointsExpirationDate)

Parameters

pointsExpirationDate
Type: String
The supported date format is YYYY-MM-DD. This input is available in API version 55.0 and later.

Return Value

Type: LoyaltyManagement.PointsInputBuilder

setProgramCurrencyName(programCurrencyName)

Represents the name of the loyalty program currency.

Signature

public LoyaltyManagement.PointsInputBuilder setProgramCurrencyName(String programCurrencyName)

Parameters

programCurrencyName
Type: String

Return Value

Type: LoyaltyManagement.PointsInputBuilder

setLoyaltyProgramCurrencySubtypeName(LoyaltyProgramCurrencySubtypeName)

This method sets specific LoyaltyProgramCurrencySubtype for the LoyaltyProgramCurrency.

Signature

public LoyaltyManagement.PointsInputBuilder setLoyaltyProgramCurrencySubtypeName(String loyaltyProgramCurrencySubtypeName)

Parameters

loyaltyProgramCurrencySubtypeName
Type: String

setProgramName(programName)

Represents the name of the loyalty program.

Signature

public LoyaltyManagement.PointsInputBuilder setProgramName(String programName)

Parameters

programName
Type: String

Return Value

Type: LoyaltyManagement.PointsInputBuilder