@avvyr/storefront-sdk - v0.19.0
    Preparing search index...

    Interface StorefrontMarket

    The public shape of a market.

    An allow-listed subset: the market document also carries merchandising rules and internal ids that stay on the server.

    interface StorefrontMarket {
        code: string;
        countryCode: string;
        currencyCode: string;
        deliveryCountries: string[];
        id: string;
        languageCode: string;
        pricesIncVat: boolean;
        pricesRequireLogin: boolean;
    }
    Index
    code countryCode currencyCode deliveryCountries id languageCode pricesIncVat pricesRequireLogin
    code: string
    countryCode: string

    The market's home country — where goods are considered to depart from.

    currencyCode: string
    deliveryCountries: string[]

    Countries this market may deliver to. An empty array means unrestricted.

    The API rejects an address outside this list with DELIVERY_COUNTRY_NOT_SUPPORTED, so a checkout should disable the others rather than let a shopper discover it on submit. Each country belongs to exactly one market, so there is always a correct market to point at.

    id: string
    languageCode: string
    pricesIncVat: boolean

    Whether displayed prices already include VAT.

    pricesRequireLogin: boolean

    Prices are shown only to signed-in customers.

    Enforced by the API, not a hint: an anonymous catalog read on such a market returns sellingPrice: null and no other price field, no price facets, ignores price sort and price filters, and refuses to add a line to a cart (PRICES_REQUIRE_LOGIN). Read this to render "sign in for price" and to leave price sort and the price facet out of the UI, rather than let the shopper discover the null.

    Settings
    Member Visibility

    On This Page
    Properties