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

    Interface MyCompanyDraft

    Draft type to represent the top level of a business. Contains the fields and values of the generic MyBusinessUnitDraft that are used specifically for creating a Company.

    interface MyCompanyDraft {
        addresses?: BaseAddress[];
        billingAddresses?: number[];
        contactEmail?: string;
        custom?: CustomFieldsDraft;
        defaultBillingAddress?: number;
        defaultShippingAddress?: number;
        key: string;
        name: string;
        shippingAddresses?: number[];
        unitType: "Company";
    }

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    addresses?: BaseAddress[]

    Addresses used by the Business Unit.

    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 identifier for the BusinessUnit.

    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.

    unitType: "Company"

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

    Settings

    Member Visibility

    On This Page

    Properties