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 | str | The name / description of this loyalty point addition. | |
| program_id | int | The ID of the loyalty program where these points were added. | |
| sub_ledger_id | str | The ID of the subledger within the loyalty program where these points were added. | |
| value | float | The amount of points that were added. | |
| desired_value | float | The original amount of loyalty points to be awarded. | [optional] |
| recipient_integration_id | str | The user for whom these points were added. | |
| start_date | datetime | Date after which points will be valid. | [optional] |
| expiry_date | datetime | Date after which points will expire. | [optional] |
| transaction_uuid | str | The identifier of this addition in the loyalty ledger. | |
| cart_item_position | float | The index of the item in the cart items list on which the loyal points addition should be applied. | [optional] |
| cart_item_sub_position | float | For cart items with `quantity` > 1, the sub position indicates to which item the loyalty points addition is applied. | [optional] |
| card_identifier | str | The alphanumeric identifier of the loyalty card. | [optional] |
| bundle_index | int | The position of the bundle in a list of item bundles created from the same bundle definition. | [optional] |
| bundle_name | str | The name of the bundle definition. | [optional] |