Interface Store

interface Store {
    countries: StoreCountry[];
    createdAt: string;
    createdBy?: CreatedBy;
    custom?: CustomFields;
    distributionChannels: ChannelReference[];
    id: string;
    key: string;
    languages: string[];
    lastModifiedAt: string;
    lastModifiedBy?: LastModifiedBy;
    name?: LocalizedString;
    productSelections: ProductSelectionSetting[];
    supplyChannels: ChannelReference[];
    version: number;
}

Hierarchy (view full)

Properties

countries createdAt createdBy? custom? distributionChannels id key languages lastModifiedAt lastModifiedBy? name? productSelections supplyChannels version

Properties

Readonly countries

countries: StoreCountry[]

Countries defined for the Store.

Readonly createdAt

createdAt: string

Date and time (UTC) the Store was initially created.

Optional Readonly createdBy

createdBy?: CreatedBy

IDs and references that created the Store.

Optional Readonly custom

custom?: CustomFields

Custom fields for the Store.

Readonly distributionChannels

distributionChannels: ChannelReference[]

Product Distribution Channels allowed for the Store.

Readonly id

id: string

Unique ID of the Store.

Readonly key

key: string

User-defined unique and immutable identifier for the Store.

Readonly languages

languages: string[]

Languages configured for the Store.

Readonly lastModifiedAt

lastModifiedAt: string

Date and time (UTC) the Store was last updated.

Optional Readonly lastModifiedBy

lastModifiedBy?: LastModifiedBy

IDs and references that last modified the Store.

Optional Readonly name

name?: LocalizedString

Name of the Store.

Readonly productSelections

productSelections: ProductSelectionSetting[]

Controls availability of Products for this Store via Product Selections:

- Leave empty if all Products in the [Project](ctp:api:type:Project) should be available in this Store.
- If only `inactive` Product Selections with `IndividualExclusion` [ProductSelectionMode](ctp:api:type:ProductSelectionMode) are provided, all the Products are availlable in this Store.
- If all the Product Selections provided are `inactive` and there's at least a Product Selection of mode `Individual`, no Product is availlable in this Store.
- If at least an `active` Product Selection is provided, only `active` Product Selections are considered to compute the availlability in this Store.

Readonly supplyChannels

supplyChannels: ChannelReference[]

Inventory Supply Channels allowed for the Store.

Readonly version

version: number

Current version of the Store.

Settings

Member Visibility

Theme

On This Page

countriescreatedAtcreatedBycustomdistributionChannelsidkeylanguageslastModifiedAtlastModifiedBynameproductSelectionssupplyChannelsversion