referrals

Syntax

customer.metafields.lantern.referrals

The referrals contains a JSON string representing an array of referral objects associated with the customer. This metafield is automatically updated whenever a referral's status changes or a new referral is created for the customer.

Each object in the array represents a single referral and includes details such as its id, status, createdAt, updatedAt, and the friendEmail of the referred customer.

The referrals stores the data as a JSON string. You will need to parse this string to access the individual referral objects in Liquid.

Properties

Type: String (JSON string) Namespace: lantern

Return Values

Scenario	Value	Type
Customer has referrals	JSON string of referral array (e.g., `"[{\"id\":\"123\", ...}]"`)	String
Customer has no referrals	`"[]"`	String
Not eligible for referrals	`null`	null
Logged out	`null`	null

Examples

Displaying Customer's Referrals

{% assign referrals_json = customer.metafields.lantern.referrals %}

{% if referrals_json != blank %}
  {% assign referrals = referrals_json | parse_json %}
  {% if referrals.size > 0 %}
    <div class="customer-referrals">
      <h4>Your Referrals</h4>
      <ul>
        {% for referral in referrals %}
          <li>
            Referral ID: {{ referral.id }}<br>
            Friend Email: {{ referral.friendEmail }}<br>
            Status: {{ referral.status }}<br>
            Created At: {{ referral.createdAt | date: "%B %d, %Y" }}
          </li>
        {% endfor %}
      </ul>
    </div>
  {% else %}
    <p>You currently have no referrals.</p>
  {% endif %}
{% else %}
  <p>You currently have no referrals.</p>
{% endif %}