Typescript SDK Type Docs
    Preparing search index...

    Interface CustomerImport

    Represents the data used to import a Customer. Once imported, this data is persisted as a Customer in the Project.

    interface CustomerImport {
        addresses?: CustomerAddress[];
        authenticationMode?: AuthenticationMode;
        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)

    Index

    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

    addresses?: CustomerAddress[]

    Maps to Customer.addresses.

    authenticationMode?: AuthenticationMode
    • Set to Password to make the password field required for the Customer.
      • Set to ExternalAuth when the password is not required for the Customer.
    billingAddresses?: number[]

    Indices of the billing addresses in the addresses array. The billingAddressIds of the Customer will be set to the id of these addresses.

    companyName?: string

    Maps to Customer.companyName.

    custom?: Custom

    Maps to Customer.custom.

    customerGroup?: CustomerGroupKeyReference

    Maps to Customer.customerGroup. If the referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the referenced CustomerGroup is created.

    customerNumber?: string

    Maps to Customer.customerNumber.

    dateOfBirth?: string

    Maps to Customer.dateOfBirth.

    defaultBillingAddress?: number

    Index of the address in the addresses array to use as the default billing address. The defaultBillingAddressId of the Customer will be set to the id of that address.

    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.

    email: string

    Maps to Customer.email.

    externalId?: string

    Maps to Customer.externalId.

    firstName?: string

    Maps to Customer.firstName.

    isEmailVerified?: boolean

    Maps to Customer.isEmailVerified.

    key: string

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

    lastName?: string

    Maps to Customer.lastName.

    locale?: string

    Maps to Customer.locale.

    middleName?: string

    Maps to Customer.middleName.

    password?: string

    Maps to Customer.password. Required when authenticationMode is set to Password. This field is only used when creating new Customers, and is ignored when updating Customers. However, due to the Import API's upsert behavior, a non-empty value must still be provided when updating Customers.

    salutation?: string

    Maps to Customer.salutation.

    shippingAddresses?: number[]

    Indices of the shipping addresses in the addresses array. The shippingAddressIds of the Customer will be set to the id of these addresses.

    stores?: StoreKeyReference[]

    Maps to Customer.stores. If the referenced Stores do not exist, the state of the ImportOperation will be set to unresolved until the referenced Stores are created.

    title?: string

    Maps to Customer.title.

    vatId?: string

    Maps to Customer.vatId.

    Settings

    Member Visibility

    On This Page

    Properties