Interface IBusinessUnit

interface IBusinessUnit {
    addresses: Address[];
    approvalRuleMode: BusinessUnitApprovalRuleMode;
    associateMode: BusinessUnitAssociateMode;
    associates: Associate[];
    billingAddressIds?: string[];
    contactEmail?: string;
    createdAt: string;
    createdBy?: CreatedBy;
    custom?: CustomFields;
    defaultBillingAddressId?: string;
    defaultShippingAddressId?: string;
    id: string;
    inheritedAssociates?: InheritedAssociate[];
    inheritedStores?: StoreKeyReference[];
    key: string;
    lastModifiedAt: string;
    lastModifiedBy?: LastModifiedBy;
    name: string;
    parentUnit?: BusinessUnitKeyReference;
    shippingAddressIds?: string[];
    status: BusinessUnitStatus;
    storeMode: BusinessUnitStoreMode;
    stores?: StoreKeyReference[];
    topLevelUnit: BusinessUnitKeyReference;
    unitType: BusinessUnitType;
    version: number;
}

Hierarchy (View Summary)

Properties

addresses approvalRuleMode associateMode associates billingAddressIds? contactEmail? createdAt createdBy? custom? defaultBillingAddressId? defaultShippingAddressId? id inheritedAssociates? inheritedStores? key lastModifiedAt lastModifiedBy? name parentUnit? shippingAddressIds? status storeMode stores? topLevelUnit unitType version

Properties

Readonlyaddresses

addresses: Address[]

Addresses used by the Business Unit.

ReadonlyapprovalRuleMode

approvalRuleMode: BusinessUnitApprovalRuleMode

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

ReadonlyassociateMode

associateMode: BusinessUnitAssociateMode

Set to Explicit to prevent the Business Unit inheriting Associates from a parent, set to ExplicitAndFromParent to enable inheritance.

Readonlyassociates

associates: Associate[]

Associates that are part of the Business Unit in specific roles.

Optional ReadonlybillingAddressIds

billingAddressIds?: string[]

Unique identifiers of addresses used as billing addresses.

Optional ReadonlycontactEmail

contactEmail?: string

Email address of the Business Unit.

ReadonlycreatedAt

createdAt: string

Date and time (UTC) the Business Unit was initially created.

Optional ReadonlycreatedBy

createdBy?: CreatedBy

IDs and references that created the BusinessUnit.

Optional Readonlycustom

custom?: CustomFields

Custom Fields for the Business Unit.

Optional ReadonlydefaultBillingAddressId

defaultBillingAddressId?: string

Unique identifier of the address used as the default billing address.

Optional ReadonlydefaultShippingAddressId

defaultShippingAddressId?: string

Unique identifier of the address used as the default shipping address.

Readonlyid

id: string

Unique identifier of the Business Unit.

Optional ReadonlyinheritedAssociates

inheritedAssociates?: InheritedAssociate[]

Associates that are inherited from a parent Business Unit. The value of this field is eventually consistent and is only present when the associateMode is set to ExplicitAndFromParent.

Optional ReadonlyinheritedStores

inheritedStores?: StoreKeyReference[]

Stores that are inherited from a parent Business Unit. The value of this field is eventually consistent and is only present when the storeMode is set to FromParent.

Readonlykey

key: string

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

ReadonlylastModifiedAt

lastModifiedAt: string

Date and time (UTC) the Business Unit was last updated.

Optional ReadonlylastModifiedBy

lastModifiedBy?: LastModifiedBy

IDs and references that last modified the BusinessUnit.

Readonlyname

name: string

Name of the Business Unit.

Optional ReadonlyparentUnit

parentUnit?: BusinessUnitKeyReference

Parent unit of the Business Unit. Only present when the unitType is Division.

Optional ReadonlyshippingAddressIds

shippingAddressIds?: string[]

Unique identifiers of addresses used as shipping addresses.

Readonlystatus

status: BusinessUnitStatus

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

ReadonlystoreMode

storeMode: BusinessUnitStoreMode

Defines whether the Stores of the Business Unit are set directly on the Business Unit or are inherited from a parent.

Optional Readonlystores

stores?: StoreKeyReference[]

References to Stores the Business Unit is associated with. Only present when storeMode is Explicit.

If the Business Unit has Stores defined, then all of its [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [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), [Quotes](ctp:api:type:Quote), [Quote Requests](ctp:api:type:QuoteRequest), or [Shopping Lists](ctp:api:type:ShoppingList) must not belong to any Store.

ReadonlytopLevelUnit

topLevelUnit: BusinessUnitKeyReference

Top-level unit of the Business Unit. The top-level unit is of unitType Company.

ReadonlyunitType

unitType: BusinessUnitType

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

Readonlyversion

version: number

Current version of the Business Unit.

Settings

Member Visibility

On This Page

Properties