Typescript SDK Type Docs
    Preparing search index...

    Interface Project

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

    Properties

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

    Properties

    businessUnits?: BusinessUnitConfiguration

    Holds configuration specific to Business Units.

    carts: CartsConfiguration

    Holds the configuration for the Carts feature.

    countries: string[]

    Country code of the geographic location.

    createdAt: string

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

    currencies: string[]

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

    discounts: DiscountsConfiguration

    Holds configuration specific to discounts, including how Product and Cart Discounts are combined in every Cart of the Project.

    externalOAuth?: ExternalOAuth

    Represents a RFC 7662 compliant OAuth 2.0 Token Introspection endpoint.

    key: string

    User-defined unique identifier of the Project.

    languages: string[]

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

    messages: MessagesConfiguration

    Holds the configuration for the Messages Query feature.

    name: string

    Name of the Project.

    searchIndexing?: SearchIndexingConfiguration

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

    shippingRateInputType?: ShippingRateInputType

    Holds the configuration for the tiered shipping rates feature.

    shoppingLists?: ShoppingListsConfiguration

    Holds the configuration for the Shopping Lists feature.

    trialUntil?: string

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

    version: number

    Current version of the Project.

    Settings

    Member Visibility

    On This Page

    Properties