Typescript SDK Type Docs
    Preparing search index...

    Interface CompanyBusinessUnitImport

    Represents a Company, the top-level of a business.

    interface CompanyBusinessUnitImport {
        addresses?: Address[];
        associates?: AssociateDraft[];
        billingAddresses?: number[];
        contactEmail?: string;
        custom?: Custom;
        defaultBillingAddress?: number;
        defaultShippingAddress?: number;
        key: string;
        name: string;
        shippingAddresses?: number[];
        status?: BusinessUnitStatus;
        storeMode?: BusinessUnitStoreMode;
        stores?: StoreKeyReference[];
        unitType: "Company";
    }

    Hierarchy (View Summary)

    Index

    Properties

    addresses? associates? billingAddresses? contactEmail? custom? defaultBillingAddress? defaultShippingAddress? key name shippingAddresses? status? storeMode? stores? unitType

    Properties

    addresses?: Address[]

    The addresses for the Business Unit.

    associates?: AssociateDraft[]

    List of Associates to be assigned to the Business Unit.

    billingAddresses?: number[]

    The indices of the billing addresses in the addresses array.

    contactEmail?: string

    The contact email address for the Business Unit.

    custom?: Custom

    Custom fields for the Business Unit.

    defaultBillingAddress?: number

    The index of the default billing address in the addresses array.

    defaultShippingAddress?: number

    The index of the default shipping address in the addresses array.

    key: string

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

    name: string

    The name of the Business Unit.

    shippingAddresses?: number[]

    The indices of the shipping addresses in the addresses array.

    status?: BusinessUnitStatus

    The status of the Business Unit.

    storeMode?: BusinessUnitStoreMode
    stores?: StoreKeyReference[]

    The Stores of the Business Unit.

    unitType: "Company"

    The type of Business Unit.

    Settings

    Member Visibility

    On This Page

    Properties