Interface Project

interface Project {
    businessUnits?: BusinessUnitConfiguration;
    carts: CartsConfiguration;
    countries: string[];
    createdAt: string;
    currencies: string[];
    externalOAuth?: ExternalOAuth;
    key: string;
    languages: string[];
    messages: MessagesConfiguration;
    name: string;
    searchIndexing?: SearchIndexingConfiguration;
    shippingRateInputType?: ShippingRateInputType;
    shoppingLists?: ShoppingListsConfiguration;
    trialUntil?: string;
    version: number;
}

Properties

businessUnits? carts countries createdAt currencies externalOAuth? key languages messages name searchIndexing? shippingRateInputType? shoppingLists? trialUntil? version

Properties

Optional Readonly businessUnits

businessUnits?: BusinessUnitConfiguration

Holds configuration specific to Business Units.

Readonly carts

carts: CartsConfiguration

Holds the configuration for the Carts feature.

Readonly countries

countries: string[]

Country code of the geographic location.

Readonly createdAt

createdAt: string

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

Readonly currencies

currencies: string[]

Currency code of the country. A Project must have at least one currency.

Optional Readonly externalOAuth

externalOAuth?: ExternalOAuth

Represents a RFC 7662 compliant OAuth 2.0 Token Introspection endpoint.

Readonly key

key: string

User-defined unique identifier of the Project.

Readonly languages

languages: string[]

Language of the country. A Project must have at least one language.

Readonly messages

messages: MessagesConfiguration

Holds the configuration for the Messages Query feature.

Readonly name

name: string

Name of the Project.

Optional Readonly searchIndexing

searchIndexing?: SearchIndexingConfiguration

Controls indexing of resources to be provided on high performance read-only search endpoints.

Optional Readonly shippingRateInputType

shippingRateInputType?: ShippingRateInputType

Holds the configuration for the tiered shipping rates feature.

Optional Readonly shoppingLists

shoppingLists?: ShoppingListsConfiguration

Holds the configuration for the Shopping Lists feature. This field may not be present on Projects created before January 2020.

Optional Readonly trialUntil

trialUntil?: string

Date in YYYY-MM format specifying when the trial period for the Project ends. Only present on Projects in trial period.

Readonly version

version: number

Current version of the Project.

Settings

Member Visibility

Theme

On This Page

businessUnitscartscountriescreatedAtcurrenciesexternalOAuthkeylanguagesmessagesnamesearchIndexingshippingRateInputTypeshoppingListstrialUntilversion