Skip to main content
Anchor to QueryRoot

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 FieldsFields

Anchor to articlearticle
•Article

Fetch a specific Article by its ID.

Arguments

Anchor to idid
•ID!
required

The ID of the Article.

Anchor to articlesarticles
•ArticleConnection!
non-null

List of the shop's articles.

Arguments

Anchor to firstfirst
•Int

Returns up to the first n elements from the list.

Anchor to afterafter
•String

Returns the elements that come after the specified cursor.

Anchor to lastlast
•Int

Returns up to the last n elements from the list.

Anchor to beforebefore
•String

Returns the elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•ArticleSortKeys
Default:ID

Sort the underlying list by the given key.

Anchor to queryquery
•String

Apply one or multiple filters to the query. Refer to the detailed search syntax for more information about using filters.

Anchor to author
•
Anchor to blog_title
•
Anchor to created_at
•
Anchor to tag_not
•
Anchor to updated_at
•
Anchor to blogblog
•Blog

Fetch a specific Blog by one of its unique attributes.

Arguments

Anchor to handlehandle
•String

The handle of the Blog.

Anchor to idid
•ID

The ID of the Blog.

Anchor to blogsblogs
•BlogConnection!
non-null

List of the shop's blogs.

Arguments

Anchor to firstfirst
•Int

Returns up to the first n elements from the list.

Anchor to afterafter
•String

Returns the elements that come after the specified cursor.

Anchor to lastlast
•Int

Returns up to the last n elements from the list.

Anchor to beforebefore
•String

Returns the elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•BlogSortKeys
Default:ID

Sort the underlying list by the given key.

Anchor to queryquery
•String

Apply one or multiple filters to the query. Refer to the detailed search syntax for more information about using filters.

Anchor to created_at
•
Anchor to handle
•
Anchor to title
•
Anchor to updated_at
•
Anchor to cartcart
•Cart

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

Arguments

Anchor to idid
•ID!
required

The ID of the cart.

Anchor to collectioncollection
•Collection

Fetch a specific Collection by one of its unique attributes.

Arguments

Anchor to idid
•ID

The ID of the Collection.

Anchor to handlehandle
•String

The handle of the Collection.

Anchor to collectionscollections
•CollectionConnection!
non-null

List of the shop’s collections.

Arguments

Anchor to firstfirst
•Int

Returns up to the first n elements from the list.

Anchor to afterafter
•String

Returns the elements that come after the specified cursor.

Anchor to lastlast
•Int

Returns up to the last n elements from the list.

Anchor to beforebefore
•String

Returns the elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•CollectionSortKeys
Default:ID

Sort the underlying list by the given key.

Anchor to queryquery
•String

Apply one or multiple filters to the query. Refer to the detailed search syntax for more information about using filters.

Anchor to collection_type
•
Anchor to title
•
Anchor to updated_at
•
Anchor to customercustomer
•Customer

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

Arguments

Anchor to customerAccessTokencustomerAccessToken
•String!
required

The customer access token.

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.

Arguments

Anchor to firstfirst
•Int

Returns up to the first n elements from the list.

Anchor to afterafter
•String

Returns the elements that come after the specified cursor.

Anchor to lastlast
•Int

Returns up to the last n elements from the list.

Anchor to beforebefore
•String

Returns the elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•LocationSortKeys
Default:ID

Sort the underlying list by the given key.

Anchor to nearnear
•GeoCoordinateInput

Used to sort results based on proximity to the provided location.

Anchor to menumenu
•Menu

Retrieve a navigation menu by its handle.

Arguments

Anchor to handlehandle
•String!
required

The navigation menu's handle.

Anchor to metaobjectmetaobject
•Metaobject

Fetch a specific Metaobject by one of its unique identifiers.

Arguments

Anchor to idid
•ID

The ID of the metaobject.

Anchor to handlehandle
•MetaobjectHandleInput

The handle and type of the metaobject.

Anchor to metaobjectsmetaobjects
•MetaobjectConnection!
non-null

All active metaobjects for the shop.

Arguments

Anchor to typetype
•String!
required

The type of metaobject to retrieve.

Anchor to sortKeysortKey
•String

The key of a field to sort with. Supports "id" and "updated_at".

Anchor to firstfirst
•Int

Returns up to the first n elements from the list.

Anchor to afterafter
•String

Returns the elements that come after the specified cursor.

Anchor to lastlast
•Int

Returns up to the last n elements from the list.

Anchor to beforebefore
•String

Returns the elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to nodenode
•Node

Returns a specific node by ID.

Arguments

Anchor to idid
•ID!
required

The ID of the Node to return.

Anchor to nodesnodes
•[Node]!
non-null

Returns the list of nodes with the given IDs.

Arguments

Anchor to idsids
•[ID!]!
required

The IDs of the Nodes to return.

The input must not contain more than 250 values.

Anchor to pagepage
•Page

Fetch a specific Page by one of its unique attributes.

Arguments

Anchor to handlehandle
•String

The handle of the Page.

Anchor to idid
•ID

The ID of the Page.

Anchor to pagespages
•PageConnection!
non-null

List of the shop's pages.

Arguments

Anchor to firstfirst
•Int

Returns up to the first n elements from the list.

Anchor to afterafter
•String

Returns the elements that come after the specified cursor.

Anchor to lastlast
•Int

Returns up to the last n elements from the list.

Anchor to beforebefore
•String

Returns the elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•PageSortKeys
Default:ID

Sort the underlying list by the given key.

Anchor to queryquery
•String

Apply one or multiple filters to the query. Refer to the detailed search syntax for more information about using filters.

Anchor to created_at
•
Anchor to handle
•
Anchor to title
•
Anchor to updated_at
•
Anchor to paymentSettingspaymentSettings
•PaymentSettings!
non-null

Settings related to payments.

Anchor to predictiveSearchpredictiveSearch
•PredictiveSearchResult

List of the predictive search results.

Arguments

Anchor to limitlimit
•Int

Limits the number of results based on limit_scope. The value can range from 1 to 10, and the default is 10.

Anchor to limitScopelimitScope
•PredictiveSearchLimitScope

Decides the distribution of results.

Anchor to queryquery
•String!
required

The search query.

Anchor to searchableFieldssearchableFields
•[SearchableField!]

Specifies the list of resource fields to use for search. The default fields searched on are TITLE, PRODUCT_TYPE, VARIANT_TITLE, and VENDOR. For the best search experience, you should search on the default field set.

The input must not contain more than 250 values.

Anchor to typestypes
•[PredictiveSearchType!]

The types of resources to search for.

The input must not contain more than 250 values.

Anchor to unavailableProductsunavailableProducts
•SearchUnavailableProductsType

Specifies how unavailable products are displayed in the search results.

Anchor to productproduct
•Product

Fetch a specific Product by one of its unique attributes.

Arguments

Anchor to idid
•ID

The ID of the Product.

Anchor to handlehandle
•String

The handle of the Product.

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.

Arguments

Anchor to productIdproductId
•ID

The id of the product.

Anchor to productHandleproductHandle
•String

The handle of the product.

Anchor to intentintent
•ProductRecommendationIntent
Default:RELATED

The recommendation intent that is used to generate product recommendations. You can use intent to generate product recommendations on various pages across the channels, according to different strategies.

Anchor to productsproducts
•ProductConnection!
non-null

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

Arguments

Anchor to firstfirst
•Int

Returns up to the first n elements from the list.

Anchor to afterafter
•String

Returns the elements that come after the specified cursor.

Anchor to lastlast
•Int

Returns up to the last n elements from the list.

Anchor to beforebefore
•String

Returns the elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•ProductSortKeys
Default:ID

Sort the underlying list by the given key.

Anchor to queryquery
•String

You can apply one or multiple filters to a query. Learn more about Shopify API search syntax.

Anchor to available_for_sale
•

Filter by products that have at least one product variant available for sale.

Anchor to created_at
•

Filter by the date and time when the product was created.

Example:

  • created_at:>'2020-10-21T23:39:20Z'
  • created_at:<now
  • created_at:<=2024
Anchor to product_type
•

Filter by a comma-separated list of product types.

Example:

  • product_type:snowboard
Anchor to tag
•

Filter products by the product tags field.

Example:

  • tag:my_tag
Anchor to tag_not
•

Filter by products that don't have the specified product tags.

Example:

  • tag_not:my_tag
Anchor to title
•

Filter by the product title field.

Example:

  • title:The Minimal Snowboard
Anchor to updated_at
•

Filter by the date and time when the product was last updated.

Example:

  • updated_at:>'2020-10-21T23:39:20Z'
  • updated_at:<now
  • updated_at:<=2024
Anchor to variants.price
•

Filter by the price of the product's variants.

Anchor to vendor
•

Filter by the product vendor field.

Example:

  • vendor:Snowdevil
  • vendor:Snowdevil OR vendor:Icedevil
Anchor to productTagsproductTags
•StringConnection!
non-null

Tags added to products. Additional access scope required: unauthenticated_read_product_tags.

Arguments

Anchor to firstfirst
•Int!
required

Returns up to the first n elements from the list.

Anchor to productTypesproductTypes
•StringConnection!
non-null

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

Arguments

Anchor to firstfirst
•Int!
required

Returns up to the first n elements from the list.

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.

Arguments

Anchor to firstfirst
•Int

Returns up to the first n elements from the list.

Anchor to afterafter
•String

Returns the elements that come after the specified cursor.

Anchor to lastlast
•Int

Returns up to the last n elements from the list.

Anchor to beforebefore
•String

Returns the elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•SearchSortKeys
Default:RELEVANCE

Sort the underlying list by the given key.

Anchor to queryquery
•String!
required

The search query.

Anchor to prefixprefix
•SearchPrefixQueryType

Specifies whether to perform a partial word match on the last search term.

Anchor to productFiltersproductFilters
•[ProductFilter!]

Returns a subset of products matching all product filters.

The input must not contain more than 250 values.

Anchor to typestypes
•[SearchType!]

The types of resources to search for.

The input must not contain more than 250 values.

Anchor to unavailableProductsunavailableProducts
•SearchUnavailableProductsType

Specifies how unavailable products or variants are displayed in 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.

Arguments

Anchor to typetype
•SitemapType!
required

The type of the resource for the sitemap.

Anchor to urlRedirectsurlRedirects
•UrlRedirectConnection!
non-null

A list of redirects for a shop.

Arguments

Anchor to firstfirst
•Int

Returns up to the first n elements from the list.

Anchor to afterafter
•String

Returns the elements that come after the specified cursor.

Anchor to lastlast
•Int

Returns up to the last n elements from the list.

Anchor to beforebefore
•String

Returns the elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to queryquery
•String

Apply one or multiple filters to the query. Refer to the detailed search syntax for more information about using filters.

Anchor to created_at
•
Anchor to path
•
Anchor to target
•

Deprecated fields

Anchor to blogByHandleblogByHandle
•Blog
Deprecated

Arguments

Anchor to handlehandle
•String!
required

The handle of the blog.

Anchor to collectionByHandlecollectionByHandle
•Collection
Deprecated

Arguments

Anchor to handlehandle
•String!
required

The handle of the collection.

Anchor to pageByHandlepageByHandle
•Page
Deprecated

Arguments

Anchor to handlehandle
•String!
required

The handle of the page.

Anchor to productByHandleproductByHandle
•Product
Deprecated

Arguments

Anchor to handlehandle
•String!
required

A unique, human-readable string of the product's title. A handle can contain letters, hyphens (-), and numbers, but no spaces. The handle is used in the online store URL for the product.

Was this section helpful?