QueryRoot - storefront - OBJECT

Version: 2024-10

Description:

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

Access Scopes

Fields

  • article: Article - Fetch a specific Article by its ID.
  • blog: Blog - Fetch a specific `Blog` by one of its unique attributes.
  • blogByHandle: Blog - Find a blog by its handle.
  • cart: Cart - Retrieve a cart by its ID. For more information, refer to [Manage a cart with the Storefront API](https://shopify.dev/custom-storefronts/cart/manage).
  • collection: Collection - Fetch a specific `Collection` by one of its unique attributes.
  • collectionByHandle: Collection - Find a collection by its handle.
  • customer: Customer - The customer associated with the given access token. Tokens are obtained by using the [`customerAccessTokenCreate` mutation](https://shopify.dev/docs/api/storefront/latest/mutations/customerAccessTokenCreate).
  • localization: Localization! - Returns the localized experiences configured for the shop.
  • menu: Menu - Retrieve a [navigation menu](https://help.shopify.com/manual/online-store/menus-and-links) by its handle.
  • metaobject: Metaobject - Fetch a specific Metaobject by one of its unique identifiers.
  • node: Node - Returns a specific node by ID.
  • nodes: Node! - Returns the list of nodes with the given IDs.
  • page: Page - Fetch a specific `Page` by one of its unique attributes.
  • pageByHandle: Page - Find a page by its handle.
  • paymentSettings: PaymentSettings! - Settings related to payments.
  • predictiveSearch: PredictiveSearchResult - List of the predictive search results.
  • product: Product - Fetch a specific `Product` by one of its unique attributes.
  • productByHandle: Product - Find a product by its handle.
  • productRecommendations: 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*](https://help.shopify.com/themes/development/recommended-products).
  • publicApiVersions: ApiVersion! - The list of public Storefront API versions, including supported, release candidate and unstable versions.
  • shop: Shop! - The shop associated with the storefront access token.
  • sitemap: Sitemap! - Contains all fields required to generate sitemaps.

Connections

  • articles: ArticleConnection!
  • blogs: BlogConnection!
  • collections: CollectionConnection!
  • locations: LocationConnection!
  • metaobjects: MetaobjectConnection!
  • pages: PageConnection!
  • productTags: StringConnection!
  • productTypes: StringConnection!
  • products: ProductConnection!
  • search: SearchResultItemConnection!
  • urlRedirects: UrlRedirectConnection!

Related queries

Related mutations

Related Unions

Examples