Accessing Lantern Data

Lantern continuously stores and updates all of the data it collects in Shopify as Custom Data using metafields and metaobjects. We use this data to build all of our storefront extensions so your store loads as quickly as possible. If you want to build custom experiences using Liquid, you can reference them the same way.

Learn more about accessing metafields and metaobjects in your Liquid code on Shopify.

Customer Metafields

Birth Date

customer.metafields.facts.birth_date

Customer's birth date in ISO 8601 format (YYYY-MM-DD). Stored as part of Shopify's standard definitions. You can display this in different formats using Shopify's Liquid Date Filter.

• Type: Date (ISO-8601)
• Example:
  • Logged in with data: 1989-12-13
  • Logged in without data: null
  • Logged out: null

Current Tier Handle

customer.metafields.lantern.loyalty_tier

The handle of the customer's current tier. Use this to reference a specific tier's data in Javascript or from the Tier metaobject.

• Type: String
• Example:
  • Logged in: bronze
  • Logged out: null

Current Points

customer.metafields.lantern.loyalty_points

The customer's current point count in string format.

• Type: Number (Integer)
• Example:
  • Logged in: 150
  • Logged out: null

Current Spend

customer.metafields.lantern.loyalty_spend

The customer's current spend count in string format without currency formatting.

• Type: Number (Decimal)
• Example:
  • Logged in: 181.50
  • Logged out: null

Referral Code

customer.metafields.lantern.referral_code

The customer's unique referral tracking code. Append this to the end of a URL with the query parameter of ref to create a referral tracking link. (https://store.url/ref?6b577dd5288)

• Type: String
• Example:
  • Logged in: 6b577dd5288
  • Logged out: null

Loyalty Eligibility

customer.metafields.lantern.is_eligible

The customer's current loyalty eligibility status. Use this to show or hide loyalty-specific features to a customer.

• Type: Boolean
• Example:
  • Logged in: true or false
  • Logged out: false

Blocked Status

customer.metafields.lantern.is_blocked

The customer's current blocked status. Use this to show or hide specific features depending on if the customer is marked as blocked in Lantern.

• Type: Boolean
• Example:
  • Logged in: true or false
  • Logged out: false

Test Account Status

customer.metafields.lantern.is_tester

Whether or not the customer is set as a developer account in Lantern.

• Type: Boolean
• Example:
  • Logged in: true or false
  • Logged out: false