YOyotpo

Retrieve Loyalty Customer Details by Email

Changed on

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

post/loyalty/v3/stores/{store_id}/customers

Request

  • Base URL
    https://developers.yotpo.com
  • URL
    https://developers.yotpo.com/loyalty/v3/stores/{store_id}/customers
  • Auth
    API key in header X-Yotpo-Token

Path parameters

store_idstring required

Your Store ID (app key).

Request body

Response

200

Example response

{
  "customers": {
    "email": "name@example.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
    },
    "yotpo_customer_id": 123456789,
    "next_points_expire_on": "2028-10-23",
    "next_points_expire_amount": 735,
    "birthday_month": 6,
    "birth_day": 20,
    "birthday_year": 1987,
    "anniversary_month": 6,
    "anniversary_day": 20,
    "anniversary_year": 1987,
    "history_items": [
      {
        "created_at": "2019-12-04T13:43:42.000Z",
        "date": "2019-12-04",
        "completed_at": "2019-12-04T13:43:42.000Z",
        "action": "Make a purchase",
        "points": 10,
        "status": "Approved",
        "action_name": "manual_adjustment",
        "order_ids": []
      }
    ],
    "referral_code": {
      "code": "dfc33q1",
      "email": "name@example.com",
      "shares": 2,
      "email_shares": 2,
      "completed_referral_customers": []
    }
  }
}

Changes