You are reading the documentation for v7.x and earlier, which is no longer the latest version. Switch to v8.x
User
User's object. User
export interface User {
'active'?: boolean;
'approvers'?: Array<User>;
'currency'?: Currency;
'customerId'?: string;
'deactivationDate'?: string;
'defaultAddress'?: Address;
'defaultPointOfServiceName'?: string;
'displayUid'?: string;
'email'?: string;
'emailLanguage'?: string;
'firstName'?: string;
'hasOrder'?: boolean;
'language'?: Language;
'lastCartId'?: string;
'lastName'?: string;
'mobileNumber'?: string;
'name'?: string;
'orgUnit'?: B2BUnit;
'roles'?: Array<string>;
'selected'?: boolean;
'title'?: string;
'titleCode'?: string;
'uid'?: string;
'userAvatar'?: UserAvatar;
}Properties
| Name | Required | Type | Description |
|---|---|---|---|
active | Optional | boolean | Boolean flag of whether the user is active/enabled or not {boolean} User |
approvers | Optional | Array<User> | List of organizational approvers {Array<User>} User |
currency | Optional | Currency | {Currency} User |
customerId | Optional | string | Customer identifier {string} User |
deactivationDate | Optional | string | Deactivation date {string} User |
defaultAddress | Optional | Address | {Address} User |
defaultPointOfServiceName | Optional | string | Name of the default pick up location {string} User |
displayUid | Optional | string | User identifier {string} User |
email | Optional | string | Email of the user {string} User |
emailLanguage | Optional | string | Email Language {string} User |
firstName | Optional | string | User first name {string} User |
hasOrder | Optional | boolean | Indicates whether customer has order. Default value is false. {boolean} User |
language | Optional | Language | {Language} User |
lastCartId | Optional | string | The latest cart operated by customer {string} User |
lastName | Optional | string | User last name {string} User |
mobileNumber | Optional | string | Mobile Number {string} User |
name | Optional | string | Name of the user {string} User |
orgUnit | Optional | B2BUnit | {B2BUnit} User |
roles | Optional | Array<string> | {Array<string>} User |
selected | Optional | boolean | Boolean flag of whether the user is selected {boolean} User |
title | Optional | string | User title {string} User |
titleCode | Optional | string | User title code {string} User |
uid | Optional | string | Unique user identifier {string} User |
userAvatar | Optional | UserAvatar | {UserAvatar} User |