User
Customer information.
interface User {
accepts_product_review_abandoned_cart_emails?: boolean;
address_count?: number;
addresses?: UserAddress[];
attribute_count?: number;
authentication?: Authentication;
channel_ids?: number[];
company?: string;
customer_group_id?: number;
date_created?: string;
date_modified?: string;
email: string;
first_name: string;
form_fields?: CustomerIdFormField[];
id?: number;
last_name: string;
notes?: string;
phone?: string;
registration_ip_address?: string;
store_credit_amounts?: {
amount: number;
}[];
tax_exempt_category?: string;
}Properties
| Name | Required | Type | Description |
|---|---|---|---|
accepts_product_review_abandoned_cart_emails | Optional | boolean | It determines if the customer is signed up to receive product review or abandoned cart emails or recieve both emails. |
address_count | Optional | number | Total number of customer addresses. |
addresses | Optional | UserAddress[] | Array of customer addresses. Limited to 10. |
attribute_count | Optional | number | Total number of customer attributes. |
authentication | Optional | Authentication | Authentication information. |
channel_ids | Optional | number[] | Array of channel ids the Customer has access to. |
company | Optional | string | The company of the customer. |
customer_group_id | Optional | number | ID of the group which this customer belongs to. |
date_created | Optional | string | The date of which the customer was created. |
date_modified | Optional | string | The date on which the customer was modified. |
email | Required | string | The email of the customer. Must be unique. |
first_name | Required | string | The first name of the customer. |
form_fields | Optional | CustomerIdFormField[] | Customer form fields. |
id | Optional | number | The unique numeric ID of the customer. |
last_name | Required | string | The last name of the customer. |
notes | Optional | string | The customer notes. |
phone | Optional | string | The phone number of the customer. |
registration_ip_address | Optional | string | The IP address from which this customer was registered. |
store_credit_amounts | Optional | { amount: number; }[] | Store credit. |
tax_exempt_category | Optional | string | The tax exempt category code for the customer. |