Interface MyDivisionDraft

Draft type to model divisions that are part of the Company or a higher-order Division. Contains the fields and values of the generic MyBusinessUnitDraft that are used specifically for creating a Division.

interface MyDivisionDraft {
    addresses?: BaseAddress[];
    billingAddresses?: number[];
    contactEmail?: string;
    custom?: CustomFieldsDraft;
    defaultBillingAddress?: number;
    defaultShippingAddress?: number;
    key: string;
    name: string;
    parentUnit: BusinessUnitResourceIdentifier;
    shippingAddresses?: number[];
    unitType: "Division";
}

Hierarchy (View Summary)

Properties

addresses? billingAddresses? contactEmail? custom? defaultBillingAddress? defaultShippingAddress? key name parentUnit shippingAddresses? unitType

Properties

Optional Readonlyaddresses

addresses?: BaseAddress[]

Addresses used by the Business Unit.

Optional ReadonlybillingAddresses

billingAddresses?: number[]

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

Optional ReadonlycontactEmail

contactEmail?: string

Email address of the Business Unit.

Optional Readonlycustom

custom?: CustomFieldsDraft

Custom Fields for the Business Unit.

Optional ReadonlydefaultBillingAddress

defaultBillingAddress?: number

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

Optional ReadonlydefaultShippingAddress

defaultShippingAddress?: number

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

Readonlykey

key: string

User-defined unique identifier for the BusinessUnit.

Readonlyname

name: string

Name of the Business Unit.

ReadonlyparentUnit

parentUnit: BusinessUnitResourceIdentifier

The parent unit of this Division. Can be a Company or a Division.

Optional ReadonlyshippingAddresses

shippingAddresses?: number[]

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

ReadonlyunitType

unitType: "Division"

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

Settings

Member Visibility

On This Page

Properties