v1

latestOpenAPI 3.1.02026-07-26620219.6 KB

Retrieve Loyalty Customer Details by Email

Retrieve a customer record from Yotpo Loyalty & Referrals (updated in real-time).

post/loyalty/v3/stores/:store_id/customers

Query parameters

access_tokenstring required

Your Yotpo access token. Click here to learn how to generate one

Request body

customer_emailstring required

The customer’s email address. Required if no pos_account_id, customer_id or phone_number is passed.

customer_idstring required

The identifier used to uniquely identify the customer in your system. Required if no customer_email, pos_account_id or phone_number is passed.

pos_account_idstring required

The identifier used to uniquely identify the customer in your POS system. Required if no customer_email, customer_id or phone_number is passed.

phone_numberstring required

The customer's phone number in E.164 format. e.g +14155552671. Must be an exact match. Required if no customer_email, pos_account_id or customer_id or is passed.

with_referral_codeboolean

Defaults to false. If you’d like information about the customers referral code you can set this to true.

with_historyboolean

Defaults to false. If you’d like information about the customers point earning and redemption history you can set this to true.

Response

200

Example response

{
  "customers": {
    "email": "tom.smith@hostname.com",
    "credit_balance": "$0",
    "credit_balance_in_customer_currency": "$0",
    "opt_in": true,
    "opted_in_at": "2022-02-01",
    "vip_tier_name": "Tier Name",
    "vip_tier_entry_date": "2022-02-01T13:05:57.071+02:00",
    "vip_tier_upgrade_requirements": {
      "points_needed": 100,
      "amount_cents_needed": 200
    }
  }
}