Retrieve Loyalty Customer Details by Email

post

https://developers.yotpo.com/loyalty/v3/stores/:store_id/customers

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

access_token

string

required

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

Body Params

customer_email

string

required

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

customer_id

string

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_id

string

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_number

string

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_code

boolean

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

with_history

boolean

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

Responses

Language

Credentials

OAuth2

Loading…

Response

Choose an example:

application/json

200200

400400