Introduction to Customers

Use Customers endpoints to sync store customers to Yotpo. You can sync information such as contact details, order history, and whether the customer agreed to receive marketing messaging.

Good to know

While you can create customers explicitly using the below endpoints, in certain scenarios customer records can also be enriched implicitly by Yotpo after interacting with a customer. For example, Yotpo will automatically enrich customer records for shoppers who reviewed a product or engaged with Loyalty features.
To manage subscriptions for various types of messaging, for example, SMS messaging, review requests, etc., dedicated endpoints should be used.

Customer endpoints

Create or Update Customer - Create/update a customer in the Yotpo platform, to be used in Yotpo SMSBump & Email
Create or Update Custom Customer Event - Allows the sending of Yotpo customer events in order to trigger flows and update customers in Yotpo SMSBump and Email
Retrieve Customers - Retrieve a list of past and existing customers as they appear in Yotpo SMSBump and Email
Retrieve Customer Details by Email - Retrieve details for a specific customer for Yotpo Reviews and Yotpo Loyalty & Referrals (updates every 24 hours)
Retrieve Customer Details by Date - Retrieve all customers that were updated since a specific date for Yotpo Reviews and Yotpo Loyalty & Referrals (updates every 24 hours)
Retrieve Loyalty Customer Details by Email - Retrieve a customer record from Yotpo Loyalty & Referrals (updated in real-time)

Customer properties

Please note that support for given operators and fields is highly specific to each endpoint. Not all properties are relevant for every endpoint, and some field names may differ slightly across endpoints.

Field	Type	Description
external_id	string	The identifier of the customer in the shop.
email / customer_email	string	The email address of the customer.
phone_number	string	The phone number of the customer in E.164 format. This number will be used for SMS messaging.
first_name	string	The first name of the customer.
last_name	string	The last name of the customer.
gender	string	Valid values: - F (Female) - M (Male) - Other
account_created_at	datetime	The date the account was originally created in the store. Must be in ISO 8601 format.
account_status	string	The status of the store account. Valid values: - enabled - disabled - invited - declined
default_language	string	The default language of the customer's account in ISO 639-1 format.
default_currency	string	The default currency for this customer. Must be valid ISO code of 3 characters. See currency codes
tags	string	Comma-separated string of tags. The merchant can later segment customers by tags.
address	object	The default address for this customer. See address object description
accepts_sms_marketing	boolean	A flag indicating whether the customer chose to accept SMS marketing messages. Please note that whether or not the customer is ultimately subscribed to messaging may be determined by additional factors.
accepts_email_marketing	boolean	A flag indicating whether the customer chose to accept email marketing messages. Please note that whether or not the customer is ultimately subscribed to messaging may be determined by additional factors.