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 Summary)

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 Readonlyaddresses

addresses?: CustomerAddress[]

Maps to Customer.addresses.

Optional ReadonlyauthenticationMode

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 ReadonlybillingAddresses

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 ReadonlycompanyName

companyName?: string

Maps to Customer.companyName.

Optional Readonlycustom

custom?: Custom

The Custom Fields for this Customer.

Optional ReadonlycustomerGroup

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 ReadonlycustomerNumber

customerNumber?: string

Maps to Customer.customerNumber.

Optional ReadonlydateOfBirth

dateOfBirth?: string

Maps to Customer.dateOfBirth.

Optional ReadonlydefaultBillingAddress

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 ReadonlydefaultShippingAddress

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.

Readonlyemail

email: string

Maps to Customer.email.

Optional ReadonlyexternalId

externalId?: string

Maps to Customer.externalId.

Optional ReadonlyfirstName

firstName?: string

Maps to Customer.firstName.

Optional ReadonlyisEmailVerified

isEmailVerified?: boolean

Maps to Customer.isEmailVerified.

Readonlykey

key: string

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

Optional ReadonlylastName

lastName?: string

Maps to Customer.lastName.

Optional Readonlylocale

locale?: string

Maps to Customer.locale.

Optional ReadonlymiddleName

middleName?: string

Maps to Customer.middleName.

Optional Readonlypassword

password?: string

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

Optional Readonlysalutation

salutation?: string

Maps to Customer.salutation.

Optional ReadonlyshippingAddresses

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 Readonlystores

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 Readonlytitle

title?: string

Maps to Customer.title.

Optional ReadonlyvatId

vatId?: string

Maps to Customer.vatId.

Settings

Member Visibility

On This Page

Properties