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

FieldTypeDescription

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.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.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.

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.

meta.mode

string

The resource environment (can be one of test or live)

Last updated