The customer object

A comprehensive list of the customer resource's attributes and relationships

A customer object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/customers endpoint.

Fields

Field	Type	Description
type	string	customers
id	string	The customer unique identifier
links.self	string	The customer endpoint URL
attributes.email	string	The customer's email address.
attributes.password	string	The customer's password. Initiate a customer password reset flow if you need to change it.
attributes.status	string	The customer's status. One of 'prospect' (default), 'acquired', or 'repeat'.
attributes.has_password	boolean	Indicates if the customer has a password.
attributes.total_orders_count	integer	The total number of orders for the customer.
attributes.shopper_reference	string	A reference to uniquely identify the shopper during payment sessions.
attributes.profile_id	string	A reference to uniquely identify the customer on any connected external services.
attributes.tax_exemption_code	string	A specific code to identify the tax exemption reason for this customer.
attributes._add_tags	string	Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
attributes._remove_tags	string	Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
attributes.created_at	datetime	Time at which the resource was created.
attributes.updated_at	datetime	Time at which the resource was last updated.
attributes.reference	string	A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
attributes.reference_origin	string	Any identifier of the third party system that defines the reference code.
attributes.jwt_custom_claim	object	The custom_claim attached to the current JWT (if any).
attributes.metadata	object	Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
attributes._request_anonymization	boolean	Send this attribute if you want to trigger anonymization.
attributes._cancel_anonymization	boolean	Send this attribute if you want to trigger a cancellation of anonymization.
attributes.anonymization_info	object	The anonymization info object.
relationships.customer_group	object	The group to which this customer belongs (optional).
relationships.customer_addresses	array	The customer's saved addresses, i.e. their address book.
relationships.customer_payment_sources	array	The customer's saved credit cards, i.e. their wallet.
relationships.customer_subscriptions	array	The customer's subscriptions.
relationships.orders	array	The customer's orders, either pending or placed.
relationships.order_subscriptions	array	The customer's order subscriptions.
relationships.returns	array	The customer's returns, either pending or shipped.
relationships.sku_lists	array	The associated SKU lists.
relationships.attachments	array	The associated attachments.
relationships.events	array	The associated events.
relationships.tags	array	The associated tags. Cannot be passed by sales channels.
relationships.jwt_customer	object	The customer associated to the JWT.
relationships.jwt_markets	array	The markets associated to the JWT.
relationships.jwt_stock_locations	array	The stock locations associated to the JWT.
meta.mode	string	The resource environment (can be one of test or live)