LoyaltyProgramTransaction.md

TalonOne::LoyaltyProgramTransaction

Properties

Name	Type	Description	Notes
id	Integer	ID of the loyalty ledger transaction.
transaction_uuid	String	Unique identifier of the transaction in the UUID format.
program_id	Integer	ID of the loyalty program.
campaign_id	Integer	ID of the campaign.	[optional]
created	Time	Date and time the loyalty transaction occurred.
type	String	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	String	Name or reason for the loyalty ledger transaction.
start_date	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.
expiry_date	String	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	String	Customer profile integration ID used in the loyalty program.	[optional]
card_identifier	String	The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`.	[optional]
subledger_id	String	ID of the subledger.
customer_session_id	String	ID of the customer session where the transaction occurred.	[optional]
import_id	Integer	ID of the import where the transaction occurred.	[optional]
user_id	Integer	ID of the user who manually added or deducted points. Applies only to manual transactions.	[optional]
user_email	String	The email of the Campaign Manager account that manually added or deducted points. Applies only to manual transactions.	[optional]
ruleset_id	Integer	ID of the ruleset containing the rule that triggered the effect. Applies only for transactions that resulted from a customer session.	[optional]
rule_name	String	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	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]

Example

require 'talon_one_sdk'

instance = TalonOne::LoyaltyProgramTransaction.new(
  id: 123,
  transaction_uuid: ce59f12a-f53b-4014-a745-636d93f2bd3f,
  program_id: 324,
  campaign_id: 324,
  created: 2022-01-02T15:04:05Z07:00,
  type: addition,
  amount: 10.25,
  name: Reward 50 points for each $500 purchase,
  start_date: 2022-01-02T15:04:05Z07:00,
  expiry_date: 2022-01-02T15:04:05Z07:00,
  customer_profile_id: kda0fajs0-fad9f-fd9dfsa9-fd9dasjf9,
  card_identifier: summer-loyalty-card-0543,
  subledger_id: sub-123,
  customer_session_id: 05c2da0d-48fa-4aa1-b629-898f58f1584d,
  import_id: 4,
  user_id: 5,
  user_email: john.doe@example.com,
  ruleset_id: 11,
  rule_name: 10 points for every $100 spent,
  flags: null,
  validity_duration: 30D
)