Customer Object

A core object in this API.

The Customer object is essentially a mirror of the Customer object from the Shopify, with our loyalty specific attributes attached.

{
  "type": "customer",
  "id": 123,
  "attributes": {
    "id": 123,
    "email": "[email protected]",
    "first_name": "Stuart",
    "last_name": "Example",
    "accepts_marketing": true,
    "orders_count": 0,
    "verified_email": true,
    "total_spent": 0.0,
    "shopify_tags": [
      "example"
    ],
    "loyalty_points_tally": 1000,
    "loyalty_status": "member",
    "loyalty_status_last_updated_at": null,
    "dob": "07-13",
    "dob_last_updated_at": "2022-07-31T13:47:32.841Z",
    "referral_url": "https://example.myshopify.com?referral_code=ZzeBK4ZXiyeGJzZg1",
    "vip_tier": {
        "id": 1,
        "name": "Gold",
        "threshold": 1250,
        "perks": [],
        "icon_url": null,
        "desc": null,
        "rewards": []
    }
  }
},

Customer Identifier

We've made it simple to identify a customer when making API requests.

You can pass either the Shopify Customer ID or Shopify Customer email using the customer_identifier parameter.