Customer checkout information

This information relates to the customer object used within the orders endpoints. It is not related to the customers endpoints.

FieldTypeDescription
external_idstringA unique customer identifier. This ID will be used to identify the customer in our database, it is used for creating profiles, attributing events to profiles, and merging profiles. If you don’t have a unique identifier for the customer, avoid using this property. If you’re using Shopify as your eCommerce platform, please use the Shopify customer ID.
Max. length: 255 characters
first_namestringThe first name of the customer who made the checkout.
Max. length: 255 characters

This parameter is required when using Yotpo Reviews.
last_namestringThe last name of the customer who made the checkout.
Max. length: 255 characters

This parameter is required when using Yotpo Reviews.
emailstringThe email address of the customer who made the checkout.
Max. length: 255 characters
phone_numberstringThe phone number of the customer who made the checkout.
Max. length: 255 characters
accepts_sms_marketingbooleanA flag indicating whether the customer chose to accept SMS marketing messaging.

Please note that whether or not the customer is ultimately subscribed to messaging may be determined by additional factors.
accepts_email_marketingbooleanA flag indicating whether the customer chose to accept email marketing messaging.

Please note that whether or not the customer is ultimately subscribed to messaging may be determined by additional factors.