Alokai
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

NameRequiredTypeDescription
activeOptionalbooleanBoolean flag of whether the user is active/enabled or not {boolean} User
approversOptionalArray<User>List of organizational approvers {Array<User>} User
currencyOptionalCurrency{Currency} User
customerIdOptionalstringCustomer identifier {string} User
deactivationDateOptionalstringDeactivation date {string} User
defaultAddressOptionalAddress{Address} User
defaultPointOfServiceNameOptionalstringName of the default pick up location {string} User
displayUidOptionalstringUser identifier {string} User
emailOptionalstringEmail of the user {string} User
emailLanguageOptionalstringEmail Language {string} User
firstNameOptionalstringUser first name {string} User
hasOrderOptionalbooleanIndicates whether customer has order. Default value is false. {boolean} User
languageOptionalLanguage{Language} User
lastCartIdOptionalstringThe latest cart operated by customer {string} User
lastNameOptionalstringUser last name {string} User
mobileNumberOptionalstringMobile Number {string} User
nameOptionalstringName of the user {string} User
orgUnitOptionalB2BUnit{B2BUnit} User
rolesOptionalArray<string>{Array<string>} User
selectedOptionalbooleanBoolean flag of whether the user is selected {boolean} User
titleOptionalstringUser title {string} User
titleCodeOptionalstringUser title code {string} User
uidOptionalstringUnique user identifier {string} User
userAvatarOptionalUserAvatar{UserAvatar} User

Referenced Types

On this page