Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.mageloyalty.com/llms.txt

Use this file to discover all available pages before exploring further.

The customer object represents a member of your loyalty program. Customers are identified by their Shopify customer ID or email address.

​
Attributes

FieldTypeDescription
shopify_customer_idstringThe customer’s Shopify customer ID
emailstringEmail address
first_namestringFirst name
last_namestringLast name
current_pointsintegerCurrent available points balance
lifetime_pointsintegerTotal points earned over the lifetime of the account
redeemed_pointsintegerTotal points spent on rewards
loyalty_statusstringEither member or excluded
date_of_birthstring | nullISO 8601 date, or null if not set
referral_urlstringThe customer’s unique referral link
referral_codestringThe customer’s referral code
vip_tierobject | nullThe customer’s current VIP tier (see below)
points_expire_atstring | nullISO 8601 date when points next expire, or null
created_atstringISO 8601 timestamp
updated_atstringISO 8601 timestamp

​
Embedded VIP tier

When present, the vip_tier object contains:
FieldTypeDescription
idstringTier ID
namestringTier name
points_requiredintegerPoints required to reach this tier
points_multipliernumberPoints earning multiplier for this tier
badge_image_urlstring | nullURL to the tier badge image
badge_colorstring | nullHex color code for the tier badge

​
Example

{
  "type": "customer",
  "id": "6789012345",
  "attributes": {
    "shopify_customer_id": "6789012345",
    "email": "jane@example.com",
    "first_name": "Jane",
    "last_name": "Doe",
    "current_points": 450,
    "lifetime_points": 1200,
    "redeemed_points": 750,
    "loyalty_status": "member",
    "date_of_birth": "1990-05-15T00:00:00.000Z",
    "referral_url": "https://mystore.myshopify.com?referral_code=ABC123",
    "referral_code": "ABC123",
    "vip_tier": {
      "id": "tier_abc",
      "name": "Gold",
      "points_required": 500,
      "points_multiplier": 1.5,
      "badge_image_url": null,
      "badge_color": "#FFD700"
    },
    "points_expire_at": null,
    "created_at": "2024-01-15T10:00:00.000Z",
    "updated_at": "2024-06-20T14:30:00.000Z"
  }
}