Customers
Customers must contain an email address and, optionally, a password. Registered customers can get an access token through the Password Flow to manage their data. Customer status can be one of "prospect," (with no orders) "acquired," (with one order) or "repeat" (with two or more orders). Associate a customer to a customer group if you want to assign a dedicated price list to that customer (learn more).
A customer object is returned as part of the response body of each successful create, list, retrieve, or update API call.
Field | Type | Description |
type |
|
|
id |
| The customer unique identifier |
links.self |
| The customer endpoint URL |
attributes.email |
| The customer's email address |
attributes.password |
| The customer's password. Initiate a customer password reset flow if you need to change it. |
attributes.status |
| The customer's status, one of 'prospect', 'acquired', or 'repeat'. |
attributes.id |
| Unique identifier for the resource (hash). |
attributes.created_at |
| Time at which the resource was created. |
attributes.updated_at |
| Time at which the resource was last updated. |
attributes.reference |
| 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.metadata |
| 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 |
| The group to which this customer belongs (optional). |
relationships.customer_addresses |
| The customer's saved addresses, i.e. their address book. |
relationships.customer_payment_sources |
| The customer's saved creadit cards, i.e. their wallet. |
relationships.customer_subscriptions |
| The customer's subscriptions. |
relationships.orders |
| The customer's orders, either pending or placed. |
meta.mode |
| The resource environment (can be one of |
