Attributes - KPI (Basket)

Attributes based on Basket/Cart of currentTxn:

---

basketSum

Profile: Current Transaction (currentTxn)
Data Type: BigDecimal
Sub-Attributes: Attribute Name and Inventory Value
Description: sum of amount of all line items which are matching input inventory attribute and their inventory attribute value matches exactly with input attribute value
Syntax: currentTxn.basketSum(“Attribute Name”,”Attribute Inventory Value”)
Example :- currentTxn.basketSum("company_code","PETRON"), this will give the sum of all the amount of petron products of company_code inventory.

---

basketSumRegex

Profile: Current Transaction (currentTxn)
Data Type: BigDecimal
Sub-Attributes: Attribute Name and Inventory Value
Description: sum of the amount of all line items which are matching input inventory attribute and their inventory attribute value matches with input regex.
Syntax: currentTxn.basketSumRegex("Inventory Attribute Name","Inventory Attribute Regex")
Example :- currentTxn.basketSumRegex("company_code","PET.*")

---

basketQty

Profile: Current Transaction (currentTxn)
Data Type: BigDecimal
Sub-Attributes: Attribute Name and Inventory Attribute Value
Description: sum of quantity of all line items which are matching input inventory attribute and their inventory attribute value exactly matches with input attribute value.
Syntax: currentTxn.basketQty("Attribute Name","Attribute Value")[OPERATORS][VALUE]
Example: currentTxn.basketQty("product","TROUSER")>=2

---

basketQtyRegex

Profile: Current Transaction (currentTxn)
Data Type: BigDecimal
Sub-Attributes: Attribute Name and Inventory Attribute Value Regex.
Description: sum of quantity of all line items which are matching input inventory attribute and their inventory attribute value matches with input regex.
Syntax: currentTxn.basketQtyRegex("Attribute Name","Attribute Value Regex")[OPERATORS][VALUE]
Example: currentTxn.basketQtyRegex("product","TR.*?")>=2

---

basketCount

Profile: Current Transaction (currentTxn)
Data Type: BigDecimal
Meaning: count of line items from request payload which are matching input inventory attribute and their inventory attribute value matches exactly with input attribute value.
Sub-Attributes: Attribute name and Attribute value
Syntax: currentTxn.basketCount(“Attribute Name”,”Attribute Value”)
Example: currentTxn.basketCount(“Brand”,”Puma”)

---

basketIncludes

Profile: Current Transaction (currentTxn)
Data Type: BigDecimal
Output Type: Boolean
Meaning: return true if any line item matches input inventory attribute and their inventory attribute value matches exactly with input attribute value, basically it returns true if the line item contains a particular Product.
Sub-Attributes: Inventory Attribute Name and Inventory Attribute Value.
Syntax: currentTxn.basketIncludes(“Attribute Name”,”Attribute Value”)
Example: currentTxn.basketIncludes(“Brand”,”Puma”)

---

basketExcludes

Profile: Current Transaction (currentTxns)
Data Type: BigDecimal
Output Type: Boolean
Meaning: return false if any lineitem matches input inventory attribute and their inventory attribute value matches with input regex or the bill does not include products whose item attribute does not match the given regular expression it returns False.
Sub-Attributes: Inventory Attribute Name and Inventory Attribute Value.
Syntax: currentTxn.basketExcludes(“Attribute Name”,”Attribute Value”)
Example: currentTxn.basketExcludes("Jeans","Levis002")

---

basketSumIf

Profile: Current Transaction (currentTxn)
Data Type: BigDecimal

Meaning: Returns the sum of the amount of line items (in basket) that satisfies a specific condition. You can define conditions based on the amount, discount, quantity, rate, or value of line items in the basket. For example, sum of line items amount in the basket whose quantity is more than 2.

Sub-Attributes: AMOUNT, DISCOUNT, QUANTITY, RATE, and VALUE.

Supported Operators: GREATER_THAN, LESS_THAN, LESS_THAN_EQUALS_TO, GREATER_THAN_EQUALS_TO, EQUALS_TO, NOT_EQUALS_TO

Syntax: currentCustomer.basketSumIf(“{Sub-Attribute}”, “{expression}”,"{value}")[operator]{value})
Example : currentTxn.basketSumIf("DISCOUNT","GREATER_THAN","10")>4

Examples of Rules for basketSumIf() Attribute.

---

basketCountIf

Profile: Current Transaction (currentTxn)
Data Type: BigDecimal

Meaning: Returns the count of line items of the basket that satisfies a specific condition. You can define conditions based on the amount, discount, quantity, rate, or value of line items in the basket.

Sub-Attributes: AMOUNT, DISCOUNT, QUANTITY, RATE, and VALUE.
Supported EXPRESSION: GREATER_THAN, LESS_THAN, LESS_THAN_EQUALS_TO, GREATER_THAN_EQUALS_TO, EQUALS_TO, NOT_EQUALS_TO

Syntax: currentTxn.basketCountIf(“{parameter}”, “{expression}”,"{value}")[operator]{value})
Example :- currentTxn.basketCountIf("DISCOUNT","GREATER_THAN","10")<5

---

basketQtyIf

Profile: Current Transaction (currentTxn)
Data Type: BigDecimal
Meaning: Return the sum of quantities of qualifying line items in the basket. The qualifying condition could be on the amount, discount, quantity, rate, or value of the line item.
For example, quantity of all line items in the basket whose discount is less or equals to $10.
currentTxn.basketQtyIf("DISCOUNT","LESS_THAN_EQUALS_TO","10")>20

Sub-Attributes: AMOUNT, DISCOUNT, QUANTITY, RATE, and VALUE.
Supported EXPRESSION: GREATER_THAN, LESS_THAN, LESS_THAN_EQUALS_TO, GREATER_THAN_EQUALS_TO, EQUALS_TO, NOT_EQUALS_TO

Syntax: currentTxn.basketCountIf(“{parameter}”, “{expression}”,"{value}")[operator]{value})
Example :- currentTxn.basketCountIf("DISCOUNT","GREATER_THAN","10")<5

---

basketSumGross

Profile: Current Transaction (currentTxn)
Data Type: BigDecimal
Meaning: Returns the sum of the gross amount of each line item in a basket whose attribute name matches with a specific value. Supported attribute names: product name, short description, SKU number, category, and subcategory.
Standard expression: currentTxn.basketSumGross{("[Attribute Name]","[Inventory Value]")[Operator][Value]}

---

basketSumRegexGross

Profile: Current Transaction (currentTxn)
Data Type: Boolean
Meaning: Returns the sum of gross amount of each line item in the basket whose product attribute values match the given regular expression.

Standard expression: currentTxn.basketSumRegexGross{("[Attribute Name]","[Attribute Regex]") [Operator] [Value]}

---

basketSumRegexBrandGross

Profile: Current Transaction (currentTxn)
Data Type: Boolean
Meaning: Returns the sum of the gross amount of each line item in the basket whose brand name matches with the given regular expression.

Standard expression: currentTxn.basketSumRegexCategoryGross{("[Regex]")[Operator][Value]}

basketSize

Profile : currentTxn
Attribute : basketSize
Type : String
Meaning : Total number of items in the bill - irrespective of quantity of each item or number of line items passed in payload
Sub-Attribute: NA
Operators: <,>,<=,>=,==
Syntax: currentTxn.basketSize.[Operators][Value]
Example: currentTxn.basketSize >= 10.