Skip to content

Latest commit

 

History

History
41 lines (30 loc) · 2.88 KB

File metadata and controls

41 lines (30 loc) · 2.88 KB

LoyaltyProgramTransaction

Properties

Name Type Description Notes
id Long ID of the loyalty ledger transaction.
transactionUUID String Unique identifier of the transaction in the UUID format.
programId Long ID of the loyalty program.
campaignId Long ID of the campaign. [optional]
created OffsetDateTime Date and time the loyalty transaction occurred.
type TypeEnum Type of transaction. Possible values: - `addition`: Signifies added points. - `subtraction`: Signifies deducted points.
amount BigDecimal Amount of loyalty points added or deducted in the transaction.
name String Name or reason for the loyalty ledger transaction.
startDate String When points become active. Possible values: - `immediate`: Points are immediately active. - `on_action`: Points become active based on the customer's action. - a timestamp value: Points become active at a given date and time.
expiryDate String When points expire. Possible values: - `unlimited`: Points have no expiration date. - a timestamp value: Points expire at a given date and time.
customerProfileId String Customer profile integration ID used in the loyalty program. [optional]
cardIdentifier String The alphanumeric identifier of the loyalty card. [optional]
subledgerId String ID of the subledger.
customerSessionId String ID of the customer session where the transaction occurred. [optional]
importId Long ID of the import where the transaction occurred. [optional]
userId Long ID of the user who manually added or deducted points. Applies only to manual transactions. [optional]
userEmail String The email of the Campaign Manager account that manually added or deducted points. Applies only to manual transactions. [optional]
rulesetId Long ID of the ruleset containing the rule that triggered the effect. Applies only for transactions that resulted from a customer session. [optional]
ruleName String Name of the rule that triggered the effect. Applies only for transactions that resulted from a customer session. [optional]
flags LoyaltyLedgerEntryFlags [optional]
validityDuration String The duration for which the points remain active, relative to the activation date. Note: This only applies to points for which `awaitsActivation` is `true` and `expiryDate` is not set. [optional]

Enum: TypeEnum

Name Value
ADDITION "addition"
SUBTRACTION "subtraction"