Attributes List
Below is a list of all the meta-language objects, along with the supported triggers and operators, that you can use when configuring your campaigns in Open Loyalty.
They are organized into sections based on the relevant trigger objects.
Member
In the referral campaigns, customer context refers to the referee.
If you want to aim the referrer, use refferer context, e.g.
referrer.labels referrer.lastTransactionDate
Personal Details
| Context Object | Description |
|---|---|
customer.firstName | Member's first name |
customer.lastName | Member's last name |
customer.gender | Member's gender |
customer.email | Member's email |
customer.phone | Member's phone number |
customer.loyaltyCardNumber | Member's loyalty card number |
Address Details
| Context Object | Description |
|---|---|
customer.address.street | Street name |
customer.address.address1 | Building name |
customer.address.address2 | Flat / Unit name |
customer.address.city | City |
customer.address.postal | Postal code |
customer.address.province | State / Province |
customer.address.country | Country |
Profile Details
| Context Object | Description |
|---|---|
customer.level | Member's current tier |
customer.levelAchievementDate | Date when member upgraded (or downgraded) to the current tier |
customer.labels | Member's custom attribute |
customer.registeredDate | Member's registration date ❗This value is separate from the member's creation date (if specified in the member's profile). |
customer.legalConsent | Legal Consent (true/false) ❗Also referred to as the Basic Legal Agreement in the member profile or as agreement1 in the API. |
customer.marketingConsent | Marketing Consent (true/false) ❗Also referred to as the Marketing Agreement in the member profile or as agreement2 in the API. |
customer.dataProcessingConsent | Data Processing Consent (true/false) ❗Also referred to as the Data Processing Agreement in the member profile or as agreement3 in the API. |
Transaction Details
All the details are based on the transactions registered and matched with the member.
| Context Object | Description |
|---|---|
customer.firstTransactionDate | Date of the member's first transaction |
customer.lastTransactionDate | Most recent date of the member's last transaction |
customer.numberOfPurchases | Total count of member's transactions |
customer.averagePurchaseAmount | Average transaction value (based on all transactions) |
Units Details
Please note these values refer to the number of units in the Default Wallet only.
| Context Object | Description |
|---|---|
customer.activePoints | Number of active units |
customer.usedPoints | Number of spent units |
customer.totalEarnedPoints | Number of total earned units |
customer.lockedPoints | Number of pending units |
customer.blockedPoints | Number of blocked units |
customer.expiredPoints | Number of expired units |
Transaction
Main Details
| Context Object | Description |
|---|---|
transaction.documentNumber | Document number |
transaction.purchasedAt | Document date |
transaction.purchasePlace | Purchase place |
transaction.labels | Transaction's custom attributes |
transaction.qty | Total quanity of items in a transaction |
transaction.grossValue | Transaction's gross value |
transaction.channelId | Channel ID |
Item details
| Context Object | Description |
|---|---|
transaction.category(‘shoes’).qty | Total number of items in a specified category |
transaction.category(‘shoes’).grossValue | Total gross value of items in a specified category |
transaction.maker(‘Nike’).qty | Total number of items of a specified brand |
transaction.maker(‘Nike’).grossValue | Total gross value of items of a specified brand |
transaction.sku(‘SKU123’).qty | Total number of items with a specified SKU |
transaction.sku(‘SKU123’).grossValue | Total gross value of items with a specified SKU |
transaction.itemLabel(‘SKU123’).qty | Total number of items with a specified custom attribute key |
transaction.itemLabel(‘SKU123’).grossValue | Total gross value of items with a specified custom attribute key |
transaction.itemLabel(‘SKU123’, ‘Value’).qty | Total number of items with a specified custom attribute key and value |
transaction.itemLabel(‘SKU123’, ‘Value’).grossValue | Total gross value of items with a specified custom attribute key and value |
transaction.itemLabels | Transaction items' custom attributes |
Custom Event
| Context Object | Description |
|---|---|
event.eventDate | Date of a custom event |
event.eventId | Event ID of a custom event
❗This field represents the external ID, if one has been added. It should not be confused with the |
event.body.sampleatributename | Attribute system identifier |
The term sampleatributename refers to the identifier assigned to an attribute in the custom event schema. For instance, if you added an attribute with the identifier colour, you would access this attribute as event.body.colour.
For further details, please refer to the article:
Internal Event
Any internal event that triggers the campaign.
Achievement Progress
| Context Object | Description |
|---|---|
event.body.progressStatuses[0].currentPeriodValue | Current value of the progress within the selected rule. |
event.body.progressStatuses[0].periodGoal | Goal value within the selected rule. |
event.body.progressStatuses[0].consecutivePeriods | Number of consecutive periods within the selected rule. |
event.body.progressStatuses[0].completedConsecutivePeriods | Completed consecutive periods within the selected rule. |
event.body.progressStatuses[0].progressChanges | Progress change (returned as number) within the selected rule. |
The objects of expressions are available only in the Achievement progressed option in the Internal Event Campaign.
event.body.progressStatuses[0] - The number [0] in the object refers to the first rule in the achievement.
Last updated