The properties specific to the "addLoyaltyPoints" effect. This gets triggered whenever a validated rule contained an "add loyalty" effect. These points are automatically stored and managed inside Talon.One.
Name | Type | Description | Notes |
---|---|---|---|
name | String | The name / description of this loyalty point addition. | |
programId | Integer | The ID of the loyalty program where these points were added. | |
subLedgerId | String | The ID of the subledger within the loyalty program where these points were added. | |
value | BigDecimal | The amount of points that were added. | |
desiredValue | BigDecimal | The original amount of loyalty points to be awarded. | [optional] |
recipientIntegrationId | String | The user for whom these points were added. | |
startDate | OffsetDateTime | Date after which points will be valid. | [optional] |
expiryDate | OffsetDateTime | Date after which points will expire. | [optional] |
transactionUUID | String | The identifier of this addition in the loyalty ledger. | |
cartItemPosition | BigDecimal | The index of the item in the cart items list on which the loyal points addition should be applied. | [optional] |
cartItemSubPosition | BigDecimal | For cart items with `quantity` > 1, the sub position indicates to which item the loyalty points addition is applied. | [optional] |
cardIdentifier | String | The alphanumeric identifier of the loyalty card. | [optional] |
bundleIndex | Integer | The position of the bundle in a list of item bundles created from the same bundle definition. | [optional] |
bundleName | String | The name of the bundle definition. | [optional] |