Choose a version:

QueryRoot

object

The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start.

Anchor to Fields and connectionsFields and connections

Anchor to articlearticle •Article: Fetch a specific Article by its ID.
Anchor to articlesarticles •ArticleConnection! non-null: List of the shop's articles.
Anchor to blogblog •Blog: Fetch a specific Blog by one of its unique attributes.
Anchor to blogsblogs •BlogConnection! non-null: List of the shop's blogs.
Anchor to cartcart •Cart: Retrieve a cart by its ID. For more information, refer to Manage a cart with the Storefront API.
Anchor to collectioncollection •Collection: Fetch a specific Collection by one of its unique attributes.
Anchor to collectionscollections •CollectionConnection! non-null: List of the shop’s collections.
Anchor to customercustomer •Customer: The customer associated with the given access token. Tokens are obtained by using the customerAccessTokenCreate mutation.
Anchor to localizationlocalization •Localization! non-null: Returns the localized experiences configured for the shop.
Anchor to locationslocations •LocationConnection! non-null: List of the shop's locations that support in-store pickup.

When sorting by distance, you must specify a location via the near argument.
Anchor to menumenu •Menu: Retrieve a navigation menu by its handle.
Anchor to metaobjectmetaobject •Metaobject: Fetch a specific Metaobject by one of its unique identifiers.
Anchor to metaobjectsmetaobjects •MetaobjectConnection! non-null: All active metaobjects for the shop.
Anchor to nodenode •Node: Returns a specific node by ID.
Anchor to nodesnodes •[Node]! non-null: Returns the list of nodes with the given IDs.
Anchor to pagepage •Page: Fetch a specific Page by one of its unique attributes.
Anchor to pagespages •PageConnection! non-null: List of the shop's pages.
Anchor to paymentSettingspaymentSettings •PaymentSettings! non-null: Settings related to payments.
Anchor to predictiveSearchpredictiveSearch •PredictiveSearchResult: List of the predictive search results.
Anchor to productproduct •Product: Fetch a specific Product by one of its unique attributes.
Anchor to productRecommendationsproductRecommendations •[Product!]: Find recommended products related to a given product_id. To learn more about how recommendations are generated, see Showing product recommendations on product pages.
Anchor to productsproducts •ProductConnection! non-null: Returns a list of the shop's products. For storefront search, use the search query.
Anchor to productTagsproductTags •StringConnection! non-null: Tags added to products. Additional access scope required: unauthenticated_read_product_tags.
Anchor to productTypesproductTypes •StringConnection! non-null: List of product types for the shop's products that are published to your app.
Anchor to publicApiVersionspublicApiVersions •[ApiVersion!]! non-null: The list of public Storefront API versions, including supported, release candidate and unstable versions.
Anchor to searchsearch •SearchResultItemConnection! non-null: List of the search results.
Anchor to shopshop •Shop! non-null: The shop associated with the storefront access token.
Anchor to sitemapsitemap •Sitemap! non-null: Contains all fields required to generate sitemaps.
Anchor to urlRedirectsurlRedirects •UrlRedirectConnection! non-null: A list of redirects for a shop.

Deprecated fields and connections

Anchor to blogByHandleblogByHandle •Blog Deprecated
Anchor to collectionByHandlecollectionByHandle •Collection Deprecated
Anchor to pageByHandlepageByHandle •Page Deprecated
Anchor to productByHandleproductByHandle •Product Deprecated

Was this section helpful?