Skip to content

Latest commit

 

History

History
45 lines (30 loc) · 2.06 KB

CheckLoyaltyBalanceBlock.md

File metadata and controls

45 lines (30 loc) · 2.06 KB

CheckLoyaltyBalanceBlock

A block that checks a specific loyalty program's ledger or subledger balance against a numeric value.

Properties

Name Type Description Notes
id String Unique identifier for this block. [optional] [readonly]
type String Identifies the block variant and determines which additional properties are present in it.
tags List<String> Semantic labels attached to this block. [optional] [readonly]
operator OperatorEnum An indicator of how the block compares the balance to the value.
program CheckLoyaltyBalanceBlockProgram
subledger String The name of the subledger to check the balance of. Can be empty if this block checks the loyalty program's main ledger balance instead of a subledger. A subledger can only be used when the loyalty program has subledgers enabled.
balance BalanceEnum The type of balance to check: - `current` is the sum of currently active points - `pending` is the sum of pending points. - `negative` is the sum of negative points. It cannot be used with a subledger. - `tentativeCurrent` is the tentative points balance within the current open customer session.
value BigDecimal The numeric value to compare the balance against.
onFailure List<Object> Promotion blocks evaluated when this block fails or returns false. [optional]

Enum: OperatorEnum

Name Value
EQUALS "equals"
NOT_EQUALS_ "not(equals)"
LESSTHAN "lessThan"
LESSTHANOREQUAL "lessThanOrEqual"
GREATERTHAN "greaterThan"
GREATERTHANOREQUAL "greaterThanOrEqual"

Enum: BalanceEnum

Name Value
CURRENT "current"
PENDING "pending"
NEGATIVE "negative"
TENTATIVECURRENT "tentativeCurrent"