Typescript SDK Type Docs
    Preparing search index...

    Interface DivisionBusinessUnitImport

    Represents a Division, a sub-unit of a Company or another Division.

    interface DivisionBusinessUnitImport {
        addresses?: Address[];
        approvalRuleMode?: BusinessUnitApprovalRuleMode;
        associateMode?: BusinessUnitAssociateMode;
        associates?: AssociateDraft[];
        billingAddresses?: number[];
        contactEmail?: string;
        custom?: Custom;
        defaultBillingAddress?: number;
        defaultShippingAddress?: number;
        key: string;
        name: string;
        parentUnit: BusinessUnitKeyReference;
        shippingAddresses?: number[];
        status?: BusinessUnitStatus;
        storeMode?: BusinessUnitStoreMode;
        stores?: StoreKeyReference[];
        unitType: "Division";
    }

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    addresses?: Address[]

    The addresses for the Business Unit.

    approvalRuleMode?: BusinessUnitApprovalRuleMode

    If Explicit, approval rules are not inherited from the parent. If ExplicitAndFromParent, approval rules are inherited from the parent.

    associateMode?: BusinessUnitAssociateMode

    If Explicit, Associates are not inherited from the parent. If ExplicitAndFromParent, Associates are inherited from the parent.

    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.

    parentUnit: BusinessUnitKeyReference

    The parent Business Unit of this Division.

    shippingAddresses?: number[]

    The indices of the shipping addresses in the addresses array.

    status?: BusinessUnitStatus

    The status of the Business Unit.

    storeMode?: BusinessUnitStoreMode

    If Explicit, the stores field cannot be empty and the Business Unit is explicitly associated with the given Stores. If FromParent, the Business Unit inherits the Stores from its parent.

    stores?: StoreKeyReference[]

    The Stores of the Business Unit.

    unitType: "Division"

    The type of Business Unit.

    Settings

    Member Visibility

    On This Page

    Properties