Name | Type | Description | Notes |
---|---|---|---|
id | Integer | ID of the loyalty ledger transaction. | |
programId | Integer | ID of the loyalty program. | |
campaignId | Integer | 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. - 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 | Integer | ID of the import where the transaction occurred. | [optional] |
userId | Integer | 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 | Integer | 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] |
Name | Value |
---|---|
ADDITION | "addition" |
SUBTRACTION | "subtraction" |