Request
Information about a specific customer. Orders for existing customers should include only the id parameter in the customer object body.
addressobjectOptional
The customer's address.
companystringOptional
The customer's company.
email_addressstringOptional
The customer's email address.
first_namestringOptional
The customer's first name.
idstringOptionalformat: "\S"1-50 characters
A unique identifier for the customer. Limited to 50 characters.
last_namestringOptional
The customer's last name.
opt_in_statusbooleanOptional
The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list will be added as Transactional members.
sms_phone_numberstringOptional
A US phone number for SMS contact.
total_spentdouble or stringOptional
Response
This endpoint returns an object.
_linkslist of objectsOptionalRead-only
A list of link types and descriptions for the API schema documents.
addressobjectOptional
The customer's address.
companystringOptional
The customer's company.
created_atdatetimeOptionalRead-only
The date and time the customer was created in ISO 8601 format.
email_addressstringOptionalRead-only
The customer's email address.
first_namestringOptional
The customer's first name.
idstringOptionalRead-only
A unique identifier for the customer.
last_namestringOptional
The customer's last name.
opt_in_statusbooleanOptional
The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list will be added as Transactional members.
orders_countintegerOptionalRead-only
The customer's total order count.
sms_phone_numberstringOptional
A US phone number for SMS contact.
total_spentdouble or stringOptional
updated_atdatetimeOptionalRead-only
The date and time the customer was last updated in ISO 8601 format.
