Home > @poq/sdk-sfcc > Customer
Document representing a customer.
Signature:
export declare class Customer extends BaseModel<Customer>
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(params) | Constructs a new instance of the Customer class |
| Property | Modifiers | Type | Description |
|---|---|---|---|
| addresses? | Array<CustomerAddress> | (Optional) The customer’s addresses. | |
| authType? | CustomerAuthTypeEnum | (Optional) The customer’s authorization type (indicates if the customer is a guest or a registered customer). | |
| birthday? | string | (Optional) The customer’s birthday. | |
| cFamilyStatus? | string | (Optional) | |
| companyName? | string | (Optional) The customer’s company name. | |
| creationDate? | string | (Optional) Returns the value of attribute ‘creationDate’. | |
| customerId? | string | (Optional) The customer’s number (id). Both registered and guest customers have a customer id. | |
| customerNo? | string | (Optional) The customer’s number (id). Only a registered customer has a customer number. | |
| email? | string | (Optional) The customer’s email address. | |
| enabled? | boolean | (Optional) A flag indicating whether this customer is is enabled and can log in. | |
| fax? | string | (Optional) The customer’s fax number. The length is restricted to 32 characters. | |
| firstName? | string | (Optional) The customer’s first name. | |
| gender? | CustomerGenderEnum | (Optional) The customer’s gender. | |
| hashedLogin? | string | (Optional) The customer’s hashed LoginId which is used for activity tracking for logged in customers in conjunction with visitId. This field is READ-ONLY | |
| jobTitle? | string | (Optional) The customer’s job title. | |
| lastLoginTime? | string | (Optional) The time when the customer last logged in. | |
| lastModified? | string | (Optional) Returns the value of attribute ‘lastModified’. | |
| lastName? | string | (Optional) The customer’s last name. | |
| lastVisitTime? | string | (Optional) The time when the customer last visited. | |
| login? | string | (Optional) The customer’s login. | |
| note? | string | (Optional) The customer’s note. | |
| paymentInstruments? | Array<CustomerPaymentInstrument> | (Optional) The customer’s payment instruments. | |
| phoneBusiness? | string | (Optional) The customer’s business phone number. | |
| phoneHome? | string | (Optional) The customer’s home phone number. | |
| phoneMobile? | string | (Optional) The customer’s mobile phone number. | |
| preferredLocale? | string | (Optional) The customer’s preferred locale. | |
| previousLoginTime? | string | (Optional) The time when the customer logged in previously. | |
| previousVisitTime? | string | (Optional) The time when the customer last visited the store. | |
| salutation? | string | (Optional) The salutation to use for the customer. | |
| secondName? | string | (Optional) The customer’s second name. | |
| suffix? | string | (Optional) The customer’s suffix (for example, “Jr.” or “Sr.”). | |
| title? | string | (Optional) The customer’s title (for example, “Mrs” or “Mr”). | |
| visitId? | string | (Optional) The customer’s visitId. This field is READ-ONLY |