Interface CustomerImport

The data representation for a Customer to be imported that is persisted as a Customer in the Project.

interface CustomerImport {
    addresses?: CustomerAddress[];
    authenticationMode?: string;
    billingAddresses?: number[];
    companyName?: string;
    custom?: Custom;
    customerGroup?: CustomerGroupKeyReference;
    customerNumber?: string;
    dateOfBirth?: string;
    defaultBillingAddress?: number;
    defaultShippingAddress?: number;
    email: string;
    externalId?: string;
    firstName?: string;
    isEmailVerified?: boolean;
    key: string;
    lastName?: string;
    locale?: string;
    middleName?: string;
    password?: string;
    salutation?: string;
    shippingAddresses?: number[];
    stores?: StoreKeyReference[];
    title?: string;
    vatId?: string;
}

Hierarchy (view full)

Properties

addresses? authenticationMode? billingAddresses? companyName? custom? customerGroup? customerNumber? dateOfBirth? defaultBillingAddress? defaultShippingAddress? email externalId? firstName? isEmailVerified? key lastName? locale? middleName? password? salutation? shippingAddresses? stores? title? vatId?

Properties

Optional Readonly addresses

addresses?: CustomerAddress[]

Maps to Customer.addresses.

Optional Readonly authenticationMode

authenticationMode?: string
  • Set to Password to make the password field required for the Customer.
    • Set to ExternalAuth when the password is not required for the Customer.

Optional Readonly billingAddresses

billingAddresses?: number[]

The indices of the billing addresses in the addresses array. The billingAddressIds of the customer will be set to the IDs of that addresses.

Optional Readonly companyName

companyName?: string

Maps to Customer.companyName.

Optional Readonly custom

custom?: Custom

The Custom Fields for this Customer.

Optional Readonly customerGroup

customerGroup?: CustomerGroupKeyReference

The Reference to the CustomerGroup with which the Customer is associated. If referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the necessary CustomerGroup is created.

Optional Readonly customerNumber

customerNumber?: string

Maps to Customer.customerNumber.

Optional Readonly dateOfBirth

dateOfBirth?: string

Maps to Customer.dateOfBirth.

Optional Readonly defaultBillingAddress

defaultBillingAddress?: number

The index of the address in the addresses array. The defaultBillingAddressId of the customer will be set to the ID of that address.

Optional Readonly defaultShippingAddress

defaultShippingAddress?: number

The index of the address in the addresses array. The defaultShippingAddressId of the customer will be set to the ID of that address.

Readonly email

email: string

Maps to Customer.email.

Optional Readonly externalId

externalId?: string

Maps to Customer.externalId.

Optional Readonly firstName

firstName?: string

Maps to Customer.firstName.

Optional Readonly isEmailVerified

isEmailVerified?: boolean

Maps to Customer.isEmailVerified.

Readonly key

key: string

User-defined unique identifier. If a Customer with this key exists, it will be updated with the imported data.

Optional Readonly lastName

lastName?: string

Maps to Customer.lastName.

Optional Readonly locale

locale?: string

Maps to Customer.locale.

Optional Readonly middleName

middleName?: string

Maps to Customer.middleName.

Optional Readonly password

password?: string

Required when authenticationMode is set to Password. Maps to Customer.password.

Optional Readonly salutation

salutation?: string

Maps to Customer.salutation.

Optional Readonly shippingAddresses

shippingAddresses?: number[]

The indices of the shipping addresses in the addresses array. The shippingAddressIds of the customer will be set to the IDs of that addresses.

Optional Readonly stores

stores?: StoreKeyReference[]

The References to the Stores with which the Customer is associated. If referenced Stores do not exist, the state of the ImportOperation will be set to unresolved until the necessary Stores are created.

Optional Readonly title

title?: string

Maps to Customer.title.

Optional Readonly vatId

vatId?: string

Maps to Customer.vatId.

Settings

Member Visibility

Theme

On This Page

addressesauthenticationModebillingAddressescompanyNamecustomcustomerGroupcustomerNumberdateOfBirthdefaultBillingAddressdefaultShippingAddressemailexternalIdfirstNameisEmailVerifiedkeylastNamelocalemiddleNamepasswordsalutationshippingAddressesstorestitlevatId