WebPresence

object

Requires read_markets for queries and both read_markets as well as write_markets for mutations.

This can be a domain (e.g. example.ca), subdomain (e.g. ca.example.com), or subfolders of the primary domain (e.g. example.com/en-ca). Each web presence comprises one or more language variants.

Note: while the domain/subfolders defined by a web presence are not applicable to custom storefronts, which must manage their own domains and routing, the languages chosen here do govern the languages available on the Storefront API for the countries using this web presence.

Anchor to Fields and connectionsFields and connections

Anchor to alternateLocalesalternateLocales • [ShopLocale!]!non-null: The ShopLocale object for the alternate locales. When a domain is used, these locales will be available as language-specific subfolders. For example, if English is an alternate locale, and example.ca is the domain, then example.ca/en will load in English.
Anchor to defaultLocaledefaultLocale • ShopLocale!non-null: The ShopLocale object for the default locale. When a domain is used, this is the locale that will be used when the domain root is accessed. For example, if French is the default locale, and example.ca is the domain, then example.ca will load in French.
Anchor to domaindomain • Domain: The web presence’s domain. This field will be null if subfolderSuffix is present.
Anchor to idid • ID!non-null: A globally-unique ID.
Anchor to marketsmarkets • MarketConnection: The associated markets for this web presence.
Anchor to rootUrlsrootUrls • [WebPresenceRootUrl!]!non-null: The list of root URLs for each of the web presence’s locales.
Anchor to subfolderSuffixsubfolderSuffix • String: The suffix of the subfolders defined by the web presence. Example: in /en-us the subfolder suffix is us. This field will be null if domain isn't null.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to Node Node • interface

Was this section helpful?