LoyaltyProgramTransaction.md

LoyaltyProgramTransaction

Properties

Name	Type	Description	Notes
id	int	ID of the loyalty ledger transaction.
transaction_uuid	str	Unique identifier of the transaction in the UUID format.
program_id	int	ID of the loyalty program.
campaign_id	int	ID of the campaign.	[optional]
created	datetime	Date and time the loyalty transaction occurred.
type	str	Type of transaction. Possible values: - `addition`: Signifies added points. - `subtraction`: Signifies deducted points.
amount	float	Amount of loyalty points added or deducted in the transaction.
name	str	Name or reason for the loyalty ledger transaction.
start_date	str	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.
expiry_date	str	When points expire. Possible values: - `unlimited`: Points have no expiration date. - a timestamp value: Points expire at a given date and time.
customer_profile_id	str	Customer profile integration ID used in the loyalty program.	[optional]
card_identifier	str	The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`.	[optional]
subledger_id	str	ID of the subledger.
customer_session_id	str	ID of the customer session where the transaction occurred.	[optional]
import_id	int	ID of the import where the transaction occurred.	[optional]
user_id	int	ID of the user who manually added or deducted points. Applies only to manual transactions.	[optional]
user_email	str	The email of the Campaign Manager account that manually added or deducted points. Applies only to manual transactions.	[optional]
ruleset_id	int	ID of the ruleset containing the rule that triggered the effect. Applies only for transactions that resulted from a customer session.	[optional]
rule_name	str	Name of the rule that triggered the effect. Applies only for transactions that resulted from a customer session.	[optional]
flags	LoyaltyLedgerEntryFlags	The flags of the transaction, when applicable. The `createsNegativeBalance` flag indicates whether the transaction results in a negative balance.	[optional]
validity_duration	str	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]

Example

from talon_one.models.loyalty_program_transaction import LoyaltyProgramTransaction

# TODO update the JSON string below
json = "{}"
# create an instance of LoyaltyProgramTransaction from a JSON string
loyalty_program_transaction_instance = LoyaltyProgramTransaction.from_json(json)
# print the JSON string representation of the object
print(LoyaltyProgramTransaction.to_json())

# convert the object into a dict
loyalty_program_transaction_dict = loyalty_program_transaction_instance.to_dict()
# create an instance of LoyaltyProgramTransaction from a dict
loyalty_program_transaction_from_dict = LoyaltyProgramTransaction.from_dict(loyalty_program_transaction_dict)

[Back to Model list] [Back to API list] [Back to README]