@gradientedge/commercetools-utils
    Preparing search index...

    Interface IBusinessUnitDraft

    interface IBusinessUnitDraft {
        addresses?: BaseAddress[];
        approvalRuleMode?: BusinessUnitApprovalRuleMode;
        associateMode?: BusinessUnitAssociateMode;
        associates?: AssociateDraft[];
        billingAddresses?: number[];
        contactEmail?: string;
        custom?: CustomFieldsDraft;
        defaultBillingAddress?: number;
        defaultShippingAddress?: number;
        key: string;
        name: string;
        shippingAddresses?: number[];
        status?: BusinessUnitStatus;
        storeMode?: BusinessUnitStoreMode;
        stores?: StoreResourceIdentifier[];
        unitType: BusinessUnitType;
    }

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    addresses?: BaseAddress[]

    Addresses used by the Business Unit.

    approvalRuleMode?: BusinessUnitApprovalRuleMode

    Determines whether the Business Unit can inherit Approval Rules from a parent. For Companies, the value of this field is always Explicit. For Divisions, the default value is ExplicitAndFromParent.

    associateMode?: BusinessUnitAssociateMode

    Determines whether the Business Unit can inherit Associates from a parent. Always Explicit for Companies and defaults to ExplicitAndFromParent for Divisions.

    associates?: AssociateDraft[]

    List of members that are part of the Business Unit in specific roles.

    billingAddresses?: number[]

    Indexes of entries in addresses to set as billing addresses. The billingAddressIds of the Customer will be replaced by these addresses.

    contactEmail?: string

    Email address of the Business Unit.

    custom?: CustomFieldsDraft

    Custom Fields for the Business Unit.

    defaultBillingAddress?: number

    Index of the entry in addresses to set as the default billing address.

    defaultShippingAddress?: number

    Index of the entry in addresses to set as the default shipping address.

    key: string

    User-defined unique and immutable identifier for the Business Unit.

    name: string

    Name of the Business Unit.

    shippingAddresses?: number[]

    Indexes of entries in addresses to set as shipping addresses. The shippingAddressIds of the Customer will be replaced by these addresses.

    status?: BusinessUnitStatus

    Indicates whether the Business Unit can be edited and used in Orders.

    storeMode?: BusinessUnitStoreMode

    Defines whether the Stores of the Business Unit are set directly on the Business Unit or are inherited from a parent. storeMode is always Explicit for Companies and defaults to FromParent for Divisions.

    stores?: StoreResourceIdentifier[]

    Sets the Stores the Business Unit is associated with. Can only be set when storeMode is Explicit. Defaults to empty for Companies and not set for Divisions.

    If the Business Unit has Stores defined, then all of its [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [Recurring Orders](ctp:api:type:RecurringOrder), [Quotes](ctp:api:type:Quote), [Quote Requests](ctp:api:type:QuoteRequest), or [Shopping Lists](ctp:api:type:ShoppingList) must belong to one of the Business Unit's Stores.

If the Business Unit has no Stores, then all of its [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [Recurring Orders](ctp:api:type:RecurringOrder), [Quotes](ctp:api:type:Quote), [Quote Requests](ctp:api:type:QuoteRequest), or [Shopping Lists](ctp:api:type:ShoppingList) must not belong to any Store.
    unitType: BusinessUnitType

    Type of the Business Unit indicating its position in a hierarchy.

    Settings

    Member Visibility

    On This Page

    Properties