Content GraphQL

Each operation has its own page with its arguments, an example and the engines that serve it. The types link to their fields on the content types page.

Operations

Operation	Description	Served by
`articles`Query	One page of the published articles, newest first: those in a section, about a topic and with a category, where each is given; with none of them, every article.
`catalogPage`Query	Fetch a catalog page (a product listing plus its surrounding content) by path.
`catalogPageByFilter`Query	The curated collection page for exactly this category and facet filter, or null where there is none, so a filtered listing knows whether it may be indexed and which path is canonical.
`contentPage`Query	Fetch a content page by path, e.g.
`contentSearch`Query	The published pages and articles that match searchTerm, at most limit (and never more than 20), and where the CMS's keyword list sends the term.
`contentSnippet`Query	Get a specific content snippet by key.
`messages`Query	The store's fixed system copy, such as the text for an empty cart.
`page`Query	Fetch any page type by path, for a route that does not know which kind of page it will land on.
`pages`Query	List pages with optional filtering and search, for sitemaps, navigation and content management.
`redirect`Query	Where a path no page holds now sends a visitor, in the request's market: a redirect for its country before one for every market.
`site`Query	The store's settings: its header and footer menus, the selling points in the header bar and the SEO templates.
`siteSettings`Query	The store's settings: which page answers each recurring purpose, such as the contact or the returns page.
`storeContentPreview`Mutation	Store content preview data for a path, so a CMS editor can preview unpublished changes.

Types

Type	Description
`ArticleList`Object	Article cards: the articles the editor picked, or else the newest that match its filters on section, topic and category.
`ArticleOverviewPage`Object	The overview of one section of articles, such as a blog or the buying guides.
`ArticlePage`Object	An article, such as a blog post, a buying guide or a news item: a page whose text owns it.
`ArticleResult`Object	One page of articles, newest first.
`AudienceType`Enum	Who a block is shown to.
`Author`Object	Who wrote an article, as the byline and the author markup name them.
`Block`Union	Rich text is also a block of its own, placed directly in a page body.
`Brand`Object	A brand.
`BrandList`Object	Brand logos that link to their brand pages, in the order the editor placed them.
`CampaignBanner`Object	A campaign: an image with the text beside it, not on it, and one call to action.
`CatalogPage`Object	Represents a product listing page with its surrounding content.
`CatalogPageFacetFilter`Object	One facet of a curated collection and the values it selects.
`CatalogPageFacetFilterInput`Input object	One facet of a listing's filter and the values it selects.
`CatalogPageLayoutType`Enum	How a catalog page presents its category.
`CategoryList`Object	Entrances to categories: the ones the editor picked, or the children of one category.
`ColumnEntry`Union	Represents content types that can be used in columns.
`Columns`Object	Two to four blocks side by side, stacked in their order on a narrow screen.
`ColumnsRatioType`Enum	How the width is shared between two columns, in the order they are placed.
`ContentAsset`Object	Represents a content asset, such as an image or file.
`ContentPage`Object	Represents a content page with various sections and blocks.
`ContentSearchHit`Object	A page or an article that matches a search.
`ContentSearchResult`Object	What the CMS answers to a search term.
`ContentSnippet`Object	Represents a snippet of content that can be used in various places.
`ContentTeaser`Object	An image beside text, or text alone, with up to two links.
`ContentVersionType`Enum	Specifies different versions of content.
`Faq`Object
`FaqGroup`Object
`FaqItem`Object
`Figure`Object	One key figure: a value with what it measures.
`FigureList`Object	Two to four key figures.
`FocalPoint`Object	A point in an image, in percent from its left and top edges.
`Hotspot`Object	One product pinned on a shoppable image.
`Image`Object	One image, or a pair side by side.
`Link`Object	A link with its own label, to one target: a page, a product, a storefront route or a URL.
`LinkVariantType`Enum	How prominently a link is drawn.
`MenuItem`Object	One menu entry: a link, or a heading for the entries below it.
`Messages`Object	The store's fixed system copy, one entry per store, for the places no editor fills by hand.
`Navigation`Object	A menu: the header's, the footer's, or one of the project's own.
`Page`Interface	A page a route can land on.
`PageRedirect`Object	Where a path sends a visitor: written by an editor, or by the CMS when a page's path changed, from the old path to the page.
`PageSortOrderType`Enum	Specifies sorting options for pages.
`PagesResult`Object	Represents the result of a query for multiple pages.
`PaymentBrandType`Enum	A way to pay the store accepts, which the site draws as that brand's logo.
`Product`Object	Product entity containing all product information, variants, and metadata.
`ProductCategory`Object	Represents a category of products.
`ProductList`Object	Products, either the variants the editor picked or those a source selects.
`Promo`Object	A card that links somewhere.
`PromoList`Object	Two to four promo cards side by side.
`ResourceLink`Object	Represents a link to a resource, either internal or external.
`ResourceLinkType`Enum	Specifies different types of resource links.
`RichText`Object	Formatted text, the same whichever CMS wrote it.
`RichTextEmbed`Union	What rich text can embed.
`RichTextImageEmbed`Object	An image placed in rich text.
`RichTextLink`Object	A link in rich text, resolved by the adapter.
`RichTextProductEmbed`Object	A product placed in rich text, by its sku.
`RichTextPromoEmbed`Object	A promo placed in rich text.
`RichTextShoppableImageEmbed`Object	A shoppable image placed in rich text.
`RichTextTipEmbed`Object	A tip placed in rich text.
`RichTextVideoEmbed`Object	A video placed in rich text.
`ShoppableImage`Object	One image with two to six products pinned on it, also listed beside or below it.
`Site`Object	The store's settings, one per store: its menus, the selling points in the header bar, its social profiles, payment brands and review rating, and the templates the SEO title and description of a page fall back to.
`SiteSettings`Object	Which page of the site answers each recurring purpose, such as the contact or the returns page, one entry per store.
`SocialLink`Object	The store's profile on a social network; the site draws the network's icon.
`SocialPlatformType`Enum	A social network a store keeps a profile on.
`Step`Object	One step of a step list.
`StepList`Object	Two to four numbered steps, such as how an account, a return or a job works.
`StoreContentPreviewData`Object	Represents data for storing content previews.
`StoreContentPreviewError`Union
`StoreContentPreviewResponse`Object
`StorefrontRouteType`Enum	A page the storefront itself serves rather than the CMS.
`TableOfContents`Object	Links to the anchors on the page.
`Tip`Object	A highlighted tip, in a page body or inside rich text.
`Topic`Object	What an article is about, such as tennis or maintenance.
`TopicPage`Object	A topic's page below a section of articles.
`TranslatedPath`Object	Represents a translated path for a specific locale.
`TrustRating`Object	The store's average review score at a review service, such as 9.2 out of 10 from 1,284 reviews, as an editor entered it.
`Usp`Object	Represents a single Unique Selling Point (USP).
`UspIconType`Enum	The icon a selling point shows, from a fixed set the storefront maps to its own glyphs.
`UspList`Object	The store's selling points, two to six of them.
`Video`Object	A YouTube video, played from the privacy-enhanced domain once the visitor consents.
`YoutubeVideo`Object	A YouTube video embedded in rich text.