Customer Object

{
  "id": "63a2c89a-9936-4bc0-9d5f-93db46110b76",
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane@doe.com",
  "phone": "+15555550123",
  "platform": "shopify",
  "platform_customer_id": "7012345678901",
  "state": "member",
  "date_of_birth": "1990-04-21",
  "referral_code": "JANE10",
  "referral_url": "https://yourstore.com?ref=JANE10",
  "points": {
    "balance": 650,
    "earned": 1200,
    "redeemed": 550
  },
  "tier": null,
  "membership": {
    "status": "active",
    "member_since": "2026-03-09T14:02:06+00:00"
  },
  "created_at": "2026-03-09T14:02:06+00:00",
  "updated_at": "2026-03-09T14:02:06+00:00"
}

{
  "id": "63a2c89a-9936-4bc0-9d5f-93db46110b76",
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane@doe.com",
  "phone": "+15555550123",
  "platform": "shopify",
  "platform_customer_id": "7012345678901",
  "state": "member",
  "date_of_birth": "1990-04-21",
  "referral_code": "JANE10",
  "referral_url": "https://yourstore.com?ref=JANE10",
  "points": {
    "balance": 650,
    "earned": 1200,
    "redeemed": 550
  },
  "tier": null,
  "membership": {
    "status": "active",
    "member_since": "2026-03-09T14:02:06+00:00"
  },
  "created_at": "2026-03-09T14:02:06+00:00",
  "updated_at": "2026-03-09T14:02:06+00:00"
}

Yuko creates customer records automatically from your Shopify store. Each customer is linked to their store account by platform and platform_customer_id. The customer object is returned by List customers and Retrieve a customer, which require the read:customers scope.

Whenever an endpoint asks for customer_id, pass the customer’s ID from your store (the platform_customer_id below, for example the Shopify customer ID), not the Yuko id.

Properties

string<uuid>

Yuko’s internal UUID for the customer.

string | null

The customer’s first name.

string | null

The customer’s last name.

string | null

The customer’s email address.

string | null

The customer’s phone number.

string

The store platform the customer comes from, for example shopify.

string | null

The customer’s ID in your store. Use this value as customer_id in API requests.

enum<string>

member for customers in the loyalty program, or disabled for customers you’ve banned from it. Customers excluded only by a customer tag still show member. One of member, disabled.

string<date> | null

The customer’s birthday in YYYY-MM-DD format, if known.

string | null

The customer’s referral code, if they have one.

string | null

The customer’s referral link, if they have a referral code.

object

The customer’s points summary.

Show points properties

integer

Spendable points. Always 0 for a banned customer or one excluded by a customer tag.

integer

Total points earned.

integer

Total points redeemed.

object | null

Returned by Retrieve a customer only. The customer’s current VIP tier, with the same fields as current_tier in the Membership Object. null if VIP tiers are turned off or the customer hasn’t reached a tier.

object

Returned by Retrieve a customer only. The customer’s loyalty membership summary.

Show membership properties

string

Always active.

string<date-time>

The date the customer was added to Yuko.

string<date-time>

When the customer was added to Yuko (ISO 8601).

string<date-time>

When the customer record was last updated (ISO 8601).

{
  "id": "63a2c89a-9936-4bc0-9d5f-93db46110b76",
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane@doe.com",
  "phone": "+15555550123",
  "platform": "shopify",
  "platform_customer_id": "7012345678901",
  "state": "member",
  "date_of_birth": "1990-04-21",
  "referral_code": "JANE10",
  "referral_url": "https://yourstore.com?ref=JANE10",
  "points": {
    "balance": 650,
    "earned": 1200,
    "redeemed": 550
  },
  "tier": null,
  "membership": {
    "status": "active",
    "member_since": "2026-03-09T14:02:06+00:00"
  },
  "created_at": "2026-03-09T14:02:06+00:00",
  "updated_at": "2026-03-09T14:02:06+00:00"
}

Rest API

API References

Object Reference

Properties

​Properties

Properties