Interface Company

Business Unit type to represent the top level of a business. Contains specific fields and values that differentiate a Company from the generic BusinessUnit.

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

Properties

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

Properties

Readonly addresses

addresses: Address[]

Addresses used by the Business Unit.

Readonly associateMode

associateMode: string

Is always Explicit since a Company cannot have a parent Business Unit that Associates can be inherited from.

Readonly associates

associates: Associate[]

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

Optional Readonly billingAddressIds

billingAddressIds?: string[]

Unique identifiers of addresses used as billing addresses.

Optional Readonly contactEmail

contactEmail?: string

Email address of the Business Unit.

Readonly createdAt

createdAt: string

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

Optional Readonly createdBy

createdBy?: CreatedBy

Present on resources created after 1 February 2019 except for events not tracked.

Optional Readonly custom

custom?: CustomFields

Custom Fields for the Business Unit.

Optional Readonly defaultBillingAddressId

defaultBillingAddressId?: string

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

Optional Readonly defaultShippingAddressId

defaultShippingAddressId?: string

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

Readonly id

id: string

Unique identifier of the Business Unit.

Optional Readonly inheritedAssociates

inheritedAssociates?: InheritedAssociate[]

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

Readonly key

key: string

User-defined unique identifier of the Business Unit.

Readonly lastModifiedAt

lastModifiedAt: string

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

Optional Readonly lastModifiedBy

lastModifiedBy?: LastModifiedBy

Present on resources updated after 1 February 2019 except for events not tracked.

Readonly name

name: string

Name of the Business Unit.

Optional Readonly parentUnit

parentUnit?: BusinessUnitKeyReference

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

Optional Readonly shippingAddressIds

shippingAddressIds?: string[]

Unique identifiers of addresses used as shipping addresses.

Readonly status

status: string

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

Readonly storeMode

storeMode: string

Is always Explicit since a Company cannot have a parent Business Unit that Stores can be inherited from.

Optional Readonly stores

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), or [Quote Requests](ctp:api:type:QuoteRequest) 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), or [Quote Requests](ctp:api:type:QuoteRequest) must not belong to any Store.

Readonly topLevelUnit

topLevelUnit: BusinessUnitKeyReference

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

Readonly unitType

unitType: "Company"

Readonly version

version: number

Current version of the Business Unit.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc