ShopifyQueryRoot

interface

import { ShopifyQueryRoot } from '@daffodil/driver/shopify'

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

interface ShopifyQueryRoot {
  __typename: "QueryRoot"
  article: ShopifyArticle
  articles: ShopifyArticleConnection
  blog: ShopifyBlog
  blogByHandle: ShopifyBlog
  blogs: ShopifyBlogConnection
  cart: ShopifyCart
  cartCompletionAttempt: ShopifyCartCompletionAttemptResult
  collection: ShopifyCollection
  collectionByHandle: ShopifyCollection
  collections: ShopifyCollectionConnection
  customer: ShopifyCustomer
  localization: ShopifyLocalization
  locations: ShopifyLocationConnection
  menu: ShopifyMenu
  metaobject: ShopifyMetaobject
  metaobjects: ShopifyMetaobjectConnection
  node: ShopifyNode
  nodes: ShopifyNode[]
  page: ShopifyPage
  pageByHandle: ShopifyPage
  pages: ShopifyPageConnection
  predictiveSearch: ShopifyPredictiveSearchResult
  product: ShopifyProduct
  productByHandle: ShopifyProduct
  productRecommendations: ShopifyProduct[]
  productTags: ShopifyStringConnection
  productTypes: ShopifyStringConnection
  products: ShopifyProductConnection
  publicApiVersions: ShopifyApiVersion[]
  search: ShopifySearchResultItemConnection
  shop: ShopifyShop
  urlRedirects: ShopifyUrlRedirectConnection
}

Properties

__typename `"QueryRoot"`

article `ShopifyArticle`
Fetch a specific Article by its ID.

articles `ShopifyArticleConnection`
List of the shop's articles.

blog `ShopifyBlog`
Fetch a specific `Blog` by one of its unique attributes.

blogByHandle `ShopifyBlog`
Find a blog by its handle.

blogs `ShopifyBlogConnection`
List of the shop's blogs.

cart `ShopifyCart`
Retrieve a cart by its ID. For more information, refer to Manage a cart with the Storefront API.

cartCompletionAttempt `ShopifyCartCompletionAttemptResult`
A poll for the status of the cart checkout completion and order creation.

collection `ShopifyCollection`
Fetch a specific `Collection` by one of its unique attributes.

collectionByHandle `ShopifyCollection`
Find a collection by its handle.

collections `ShopifyCollectionConnection`
List of the shop’s collections.

customer `ShopifyCustomer`
The customer associated with the given access token. Tokens are obtained by using the `customerAccessTokenCreate` mutation.

localization `ShopifyLocalization`
Returns the localized experiences configured for the shop.

locations `ShopifyLocationConnection`
List of the shop's locations that support in-store pickup. When sorting by distance, you must specify a location via the `near` argument.

locations

ShopifyLocationConnection

List of the shop's locations that support in-store pickup.

When sorting by distance, you must specify a location via the near argument.

menu `ShopifyMenu`
Retrieve a navigation menu by its handle.

metaobject `ShopifyMetaobject`
Fetch a specific Metaobject by one of its unique identifiers.

metaobjects `ShopifyMetaobjectConnection`
All active metaobjects for the shop.

node `ShopifyNode`
Returns a specific node by ID.

nodes `ShopifyNode[]`
Returns the list of nodes with the given IDs.

page `ShopifyPage`
Fetch a specific `Page` by one of its unique attributes.

pageByHandle `ShopifyPage`
Find a page by its handle.

pages `ShopifyPageConnection`
List of the shop's pages.

predictiveSearch `ShopifyPredictiveSearchResult`
List of the predictive search results.

product `ShopifyProduct`
Fetch a specific `Product` by one of its unique attributes.

productByHandle `ShopifyProduct`
Find a product by its handle.

productRecommendations `ShopifyProduct[]`
Find recommended products related to a given `product_id`. To learn more about how recommendations are generated, see Showing product recommendations on product pages.

productTags `ShopifyStringConnection`
Tags added to products. Additional access scope required: unauthenticated_read_product_tags.

productTypes `ShopifyStringConnection`
List of product types for the shop's products that are published to your app.

products `ShopifyProductConnection`
Returns a list of the shop's products. For storefront search, use the `search` query.

publicApiVersions `ShopifyApiVersion[]`
The list of public Storefront API versions, including supported, release candidate and unstable versions.

search `ShopifySearchResultItemConnection`
List of the search results.

shop `ShopifyShop`
The shop associated with the storefront access token.

urlRedirects `ShopifyUrlRedirectConnection`
A list of redirects for a shop.