Skip to main content
Content Variables

A list of the variables available to be used in your Online Store content as well as information about how they work and can be used.

Kyle Peatt avatar
Written by Kyle Peatt
Updated over 5 months ago

Member

Member variables are available in any content field when a member is logged in. For logged out customers, the variable will be replaced with empty text.

{{ first_name }} — Customer's first name.

  • Example:

    • Logged in: Enrico

{{ last_name }} — Customer's last name.

  • Example:

    • Logged in: Matassa

{{ initials }} — Initials constructed from the member's first and last name. If a member only has a first or last name, only one initial will be shown.

  • Example:

    • Logged in: HV

{{ email }} — Customer's email address.


Loyalty

Loyalty variables in the General section are available in any content field. Variables with specific values may render differently for logged out or ineligible users. See the specific variable for more information. Loyalty variables outside of the General section can only be used in the fields listed. If you need to use a variable and it's not available in the field you want to edit, reach out to us and we'll see what we can do.

General

{{ point_unit }}  — The singular form of the term you use for points. You can change in the Content section of Online Store in the Lantern app.

  • Example:

    • All users: point

{{ point_units }} — The plural form of the term you use for points. You can change in the Content section of Online Store in the Lantern app.

  • Example:

    • All users: points

{{ total_points }} — The current number of points the member has available to spend with the unit.

  • Example:

    • Members: 500 points.

    • Logged out or ineligible: 0 points

{{ total_points_unformatted }} — The current number of points the member has available to spend without the unit.

  • Example:

    • Members: 500

    • Logged out or ineligible: 0

{{ earn_rate }} — The current point multiplier active for this user without the per dollar amount. Based on the default earn rate and any active point multipliers from tier or point multiplier events.

  • Example:

    • All users: 1 point

    • Members with a higher earn rate: 2 points

{{ earn_rate_unformatted }} — The current point multiplier active for this user without the per dollar amount and without the point unit. Based on the default earn rate and any active point multipliers from tier or point multiplier events.

  • Example:

    • All users: 1

    • Members with a higher earn rate: 2

{{ tier_spend }} — The current qualifying amount the member has spent during the current loyalty period. This is the same value used to calculate the user's current tier. Uses the currency formatting setting from your Shopify settings.

  • Example:

    • Logged out or ineligible users: $0

    • Members with qualifying spend: $300

{{ tier_name }} — The name of the member's current tier. Blank for logged out or ineligible users when used in a field accessible to them.

  • Example:

    • Logged out or ineligible users:

    • Members with qualifying spend: Silver

{{ next_tier_name }} — The name of the next tier available to the member. Blank for logged out or ineligible users and for members on the highest tier.

  • Example:

    • Logged out or ineligible users:

    • Members with qualifying spend: Gold

    • Members on the highest tier:

{{ next_tier_spend }} — The remaining spend required for the member to reach the next tier. Blank for logged out or ineligible users and for members on the highest tier. Uses the currency formatting setting from your Shopify settings.

  • Example:

    • Logged out or ineligible users:

    • Members with qualifying spend: $80

    • Members on the highest tier:

{{ next_tier_spend_unformatted }} — The remaining spend required for the member to reach the next tier without any formatting. Blank for logged out or ineligible users and for members on the highest tier.

  • Example:

    • Logged out or ineligible users:

    • Members with qualifying spend: 80

    • Members on the highest tier:

Purchase Related

{{ potential_points }} — The potential number of points a customer will earn by making this purchase. Based on the default earn rate and any active point multipliers from tier or point multiplier events.

  • Available on fields used on the:

    • Product Detail Page

    • Cart

    • Checkout

  • Example:

    • All users: 320 points

    • Members with a higher earn rate: 640 points


Referrals

Referral variables are available in all fields when your referral program is active. Variables with specific values may render differently for logged out or ineligible users. See the specific variable for more information. Referral variables outside of the General section can only be used in the fields listed. If you need to use a variable and it's not available in the field you want to edit, reach out to us and we'll see what we can do.

General

{{ friend_reward }} — A description of the reward the Friend will receive after a successful referral.

  • Example:

    • Gift card or store credit: $10 credit

    • Amount off discount: $10 discount

    • Percent off discount: 10% discount

{{ friend_reward_type }} — The type of the reward the Friend will receive after a successful referral.

  • Example:

    • Gift card or store credit: credit

    • Discount: discount

{{ friend_reward_value }} — The value of the reward the referred member will receive after a successful referral. Uses the currency formatting setting from your Shopify settings.

  • Example:

    • Gift card or store credit: $10

    • Amount off discount: $10

    • Percent off discount: 10%

{{ advocate_reward }} — A description of the reward the referring member will receive after a successful referral.

  • Example:

    • Gift card or store credit: $10 credit

    • Amount off discount: $10 discount

    • Percent off discount: 10% discount

{{ advocate_reward_type }} — The type of the reward the referring member will receive after a successful referral.

  • Example:

    • Gift card or store credit: credit

    • Discount: discount

{{ advocate_reward_value }} — The value of the reward the referring member will receive after a successful referral. Uses the currency formatting setting from your Shopify settings.

  • Example:

    • Gift card or store credit: $10

    • Amount off discount: $10

    • Percent off discount: 10%

{{ referral_order_limit }} — The minimum spend amount required for a referral to receive the rewards. Uses the currency formatting setting from your Shopify settings.

  • Example:

    • All users: $10

{{ referral_friend_spend }} — The minimum spend amount required for a referral to receive the rewards. Uses the currency formatting setting from your Shopify settings.

  • Example:

    • All users: $100

{{ referral_friend_spend_unformatted }} — The minimum spend amount required for a referral to receive the rewards. Uses the currency formatting setting from your Shopify settings.

  • Example:

    • All users: 100

Referred Friends List

{{ friend_email }} — The email address of the most recent referred Friend. Only available after a successful email share.

  • Available on specific field:

    • Referral > List > Success

  • Example:


Order

Order variables are only available in the Order Event fields. If you need to use a variable and it's not available in the field you want to edit, reach out to us and we'll see what we can do.

{{ location }} — A short identifiable version of the most important address for the order. For shipping orders, this is the street number and street name of the shipment. For pickup orders, this is the street number and street name of the store location. For orders without an address, this is replaced with empty text.

  • Example: 123 Main St.

{{ date }} — A plain language version of when the Order Event occurred.

  • Example: March 4th

{{ today_or_date }} — A plain language version of when the Order Event occurred that can optionally show today if the date is the current date.

  • Example:

    • When the date is today: today

    • When the date is in the future: March 4th

{{ date_time }} — A formatted version of when the Order Event occurred.

  • Example: March 4th at 3:45pm

Did this answer your question?