com.shopify.buy3

Class Storefront.QueryRootQuery

java.lang.Object

com.shopify.graphql.support.Query<Storefront.QueryRootQuery>

com.shopify.buy3.Storefront.QueryRootQuery

Enclosing class:

Storefront

public static class Storefront.QueryRootQuery
extends Query<Storefront.QueryRootQuery>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Storefront.QueryRootQuery.ArticlesArguments
static interface	Storefront.QueryRootQuery.ArticlesArgumentsDefinition
class	Storefront.QueryRootQuery.BlogArguments
static interface	Storefront.QueryRootQuery.BlogArgumentsDefinition
class	Storefront.QueryRootQuery.BlogsArguments
static interface	Storefront.QueryRootQuery.BlogsArgumentsDefinition
class	Storefront.QueryRootQuery.CollectionArguments
static interface	Storefront.QueryRootQuery.CollectionArgumentsDefinition
class	Storefront.QueryRootQuery.CollectionsArguments
static interface	Storefront.QueryRootQuery.CollectionsArgumentsDefinition
class	Storefront.QueryRootQuery.LocationsArguments
static interface	Storefront.QueryRootQuery.LocationsArgumentsDefinition
class	Storefront.QueryRootQuery.MetaobjectArguments
static interface	Storefront.QueryRootQuery.MetaobjectArgumentsDefinition
class	Storefront.QueryRootQuery.MetaobjectsArguments
static interface	Storefront.QueryRootQuery.MetaobjectsArgumentsDefinition
class	Storefront.QueryRootQuery.PageArguments
static interface	Storefront.QueryRootQuery.PageArgumentsDefinition
class	Storefront.QueryRootQuery.PagesArguments
static interface	Storefront.QueryRootQuery.PagesArgumentsDefinition
class	Storefront.QueryRootQuery.PredictiveSearchArguments
static interface	Storefront.QueryRootQuery.PredictiveSearchArgumentsDefinition
class	Storefront.QueryRootQuery.ProductArguments
static interface	Storefront.QueryRootQuery.ProductArgumentsDefinition
class	Storefront.QueryRootQuery.ProductRecommendationsArguments
static interface	Storefront.QueryRootQuery.ProductRecommendationsArgumentsDefinition
class	Storefront.QueryRootQuery.ProductsArguments
static interface	Storefront.QueryRootQuery.ProductsArgumentsDefinition
class	Storefront.QueryRootQuery.SearchArguments
static interface	Storefront.QueryRootQuery.SearchArgumentsDefinition
class	Storefront.QueryRootQuery.UrlRedirectsArguments
static interface	Storefront.QueryRootQuery.UrlRedirectsArgumentsDefinition

Field Summary

Fields inherited from class com.shopify.graphql.support.Query

_queryBuilder, ALIAS_SUFFIX_SEPARATOR

Method Summary

Modifier and Type	Method and Description
Storefront.QueryRootQuery	article(ID id, Storefront.ArticleQueryDefinition queryDef) Fetch a specific Article by its ID.
Storefront.QueryRootQuery	articles(Storefront.ArticleConnectionQueryDefinition queryDef) List of the shop's articles.
Storefront.QueryRootQuery	articles(Storefront.QueryRootQuery.ArticlesArgumentsDefinition argsDef, Storefront.ArticleConnectionQueryDefinition queryDef) List of the shop's articles.
Storefront.QueryRootQuery	blog(Storefront.BlogQueryDefinition queryDef) Fetch a specific `Blog` by one of its unique attributes.
Storefront.QueryRootQuery	blog(Storefront.QueryRootQuery.BlogArgumentsDefinition argsDef, Storefront.BlogQueryDefinition queryDef) Fetch a specific `Blog` by one of its unique attributes.
Storefront.QueryRootQuery	blogByHandle(java.lang.String handle, Storefront.BlogQueryDefinition queryDef) Deprecated. Use `blog` instead.
Storefront.QueryRootQuery	blogs(Storefront.BlogConnectionQueryDefinition queryDef) List of the shop's blogs.
Storefront.QueryRootQuery	blogs(Storefront.QueryRootQuery.BlogsArgumentsDefinition argsDef, Storefront.BlogConnectionQueryDefinition queryDef) List of the shop's blogs.
Storefront.QueryRootQuery	cart(ID id, Storefront.CartQueryDefinition queryDef) Retrieve a cart by its ID.
Storefront.QueryRootQuery	cartCompletionAttempt(java.lang.String attemptId, Storefront.CartCompletionAttemptResultQueryDefinition queryDef) A poll for the status of the cart checkout completion and order creation.
Storefront.QueryRootQuery	collection(Storefront.CollectionQueryDefinition queryDef) Fetch a specific `Collection` by one of its unique attributes.
Storefront.QueryRootQuery	collection(Storefront.QueryRootQuery.CollectionArgumentsDefinition argsDef, Storefront.CollectionQueryDefinition queryDef) Fetch a specific `Collection` by one of its unique attributes.
Storefront.QueryRootQuery	collectionByHandle(java.lang.String handle, Storefront.CollectionQueryDefinition queryDef) Deprecated. Use `collection` instead.
Storefront.QueryRootQuery	collections(Storefront.CollectionConnectionQueryDefinition queryDef) List of the shop’s collections.
Storefront.QueryRootQuery	collections(Storefront.QueryRootQuery.CollectionsArgumentsDefinition argsDef, Storefront.CollectionConnectionQueryDefinition queryDef) List of the shop’s collections.
Storefront.QueryRootQuery	customer(java.lang.String customerAccessToken, Storefront.CustomerQueryDefinition queryDef) The customer associated with the given access token.
Storefront.QueryRootQuery	localization(Storefront.LocalizationQueryDefinition queryDef) Returns the localized experiences configured for the shop.
Storefront.QueryRootQuery	locations(Storefront.LocationConnectionQueryDefinition queryDef) List of the shop's locations that support in-store pickup.
Storefront.QueryRootQuery	locations(Storefront.QueryRootQuery.LocationsArgumentsDefinition argsDef, Storefront.LocationConnectionQueryDefinition queryDef) List of the shop's locations that support in-store pickup.
Storefront.QueryRootQuery	menu(java.lang.String handle, Storefront.MenuQueryDefinition queryDef) Retrieve a [navigation menu](https://help.shopify.com/manual/online-store/menus-and-links) by its handle.
Storefront.QueryRootQuery	metaobject(Storefront.MetaobjectQueryDefinition queryDef) Fetch a specific Metaobject by one of its unique identifiers.
Storefront.QueryRootQuery	metaobject(Storefront.QueryRootQuery.MetaobjectArgumentsDefinition argsDef, Storefront.MetaobjectQueryDefinition queryDef) Fetch a specific Metaobject by one of its unique identifiers.
Storefront.QueryRootQuery	metaobjects(java.lang.String type, Storefront.MetaobjectConnectionQueryDefinition queryDef) All active metaobjects for the shop.
Storefront.QueryRootQuery	metaobjects(java.lang.String type, Storefront.QueryRootQuery.MetaobjectsArgumentsDefinition argsDef, Storefront.MetaobjectConnectionQueryDefinition queryDef) All active metaobjects for the shop.
Storefront.QueryRootQuery	node(ID id, Storefront.NodeQueryDefinition queryDef) Returns a specific node by ID.
Storefront.QueryRootQuery	nodes(java.util.List<ID> ids, Storefront.NodeQueryDefinition queryDef) Returns the list of nodes with the given IDs.
Storefront.QueryRootQuery	page(Storefront.PageQueryDefinition queryDef) Fetch a specific `Page` by one of its unique attributes.
Storefront.QueryRootQuery	page(Storefront.QueryRootQuery.PageArgumentsDefinition argsDef, Storefront.PageQueryDefinition queryDef) Fetch a specific `Page` by one of its unique attributes.
Storefront.QueryRootQuery	pageByHandle(java.lang.String handle, Storefront.PageQueryDefinition queryDef) Deprecated. Use `page` instead.
Storefront.QueryRootQuery	pages(Storefront.PageConnectionQueryDefinition queryDef) List of the shop's pages.
Storefront.QueryRootQuery	pages(Storefront.QueryRootQuery.PagesArgumentsDefinition argsDef, Storefront.PageConnectionQueryDefinition queryDef) List of the shop's pages.
Storefront.QueryRootQuery	predictiveSearch(java.lang.String query, Storefront.PredictiveSearchResultQueryDefinition queryDef) List of the predictive search results.
Storefront.QueryRootQuery	predictiveSearch(java.lang.String query, Storefront.QueryRootQuery.PredictiveSearchArgumentsDefinition argsDef, Storefront.PredictiveSearchResultQueryDefinition queryDef) List of the predictive search results.
Storefront.QueryRootQuery	product(Storefront.ProductQueryDefinition queryDef) Fetch a specific `Product` by one of its unique attributes.
Storefront.QueryRootQuery	product(Storefront.QueryRootQuery.ProductArgumentsDefinition argsDef, Storefront.ProductQueryDefinition queryDef) Fetch a specific `Product` by one of its unique attributes.
Storefront.QueryRootQuery	productByHandle(java.lang.String handle, Storefront.ProductQueryDefinition queryDef) Deprecated. Use `product` instead.
Storefront.QueryRootQuery	productRecommendations(Storefront.ProductQueryDefinition queryDef) Find recommended products related to a given `product_id`.
Storefront.QueryRootQuery	productRecommendations(Storefront.QueryRootQuery.ProductRecommendationsArgumentsDefinition argsDef, Storefront.ProductQueryDefinition queryDef) Find recommended products related to a given `product_id`.
Storefront.QueryRootQuery	products(Storefront.ProductConnectionQueryDefinition queryDef) List of the shop’s products.
Storefront.QueryRootQuery	products(Storefront.QueryRootQuery.ProductsArgumentsDefinition argsDef, Storefront.ProductConnectionQueryDefinition queryDef) List of the shop’s products.
Storefront.QueryRootQuery	productTags(int first, Storefront.StringConnectionQueryDefinition queryDef) Tags added to products.
Storefront.QueryRootQuery	productTypes(int first, Storefront.StringConnectionQueryDefinition queryDef) List of product types for the shop's products that are published to your app.
Storefront.QueryRootQuery	publicApiVersions(Storefront.ApiVersionQueryDefinition queryDef) The list of public Storefront API versions, including supported, release candidate and unstable versions.
Storefront.QueryRootQuery	search(java.lang.String query, Storefront.QueryRootQuery.SearchArgumentsDefinition argsDef, Storefront.SearchResultItemConnectionQueryDefinition queryDef) List of the search results.
Storefront.QueryRootQuery	search(java.lang.String query, Storefront.SearchResultItemConnectionQueryDefinition queryDef) List of the search results.
Storefront.QueryRootQuery	shop(Storefront.ShopQueryDefinition queryDef) The shop associated with the storefront access token.
java.lang.String	toString()
Storefront.QueryRootQuery	urlRedirects(Storefront.QueryRootQuery.UrlRedirectsArgumentsDefinition argsDef, Storefront.UrlRedirectConnectionQueryDefinition queryDef) A list of redirects for a shop.
Storefront.QueryRootQuery	urlRedirects(Storefront.UrlRedirectConnectionQueryDefinition queryDef) A list of redirects for a shop.

Methods inherited from class com.shopify.graphql.support.Query

appendQuotedString, startField, startInlineFragment, withAlias

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

article

public Storefront.QueryRootQuery article(ID id,
                                         Storefront.ArticleQueryDefinition queryDef)

Fetch a specific Article by its ID.

articles

public Storefront.QueryRootQuery articles(Storefront.ArticleConnectionQueryDefinition queryDef)

List of the shop's articles.

articles

public Storefront.QueryRootQuery articles(Storefront.QueryRootQuery.ArticlesArgumentsDefinition argsDef,
                                          Storefront.ArticleConnectionQueryDefinition queryDef)

List of the shop's articles.

blog

public Storefront.QueryRootQuery blog(Storefront.BlogQueryDefinition queryDef)

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

blog

public Storefront.QueryRootQuery blog(Storefront.QueryRootQuery.BlogArgumentsDefinition argsDef,
                                      Storefront.BlogQueryDefinition queryDef)

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

blogByHandle

@Deprecated
public Storefront.QueryRootQuery blogByHandle(java.lang.String handle,
                                                          Storefront.BlogQueryDefinition queryDef)

Deprecated. Use `blog` instead.

Find a blog by its handle.

blogs

public Storefront.QueryRootQuery blogs(Storefront.BlogConnectionQueryDefinition queryDef)

List of the shop's blogs.

blogs

public Storefront.QueryRootQuery blogs(Storefront.QueryRootQuery.BlogsArgumentsDefinition argsDef,
                                       Storefront.BlogConnectionQueryDefinition queryDef)

List of the shop's blogs.

cart

public Storefront.QueryRootQuery cart(ID id,
                                      Storefront.CartQueryDefinition queryDef)

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).

cartCompletionAttempt

public Storefront.QueryRootQuery cartCompletionAttempt(java.lang.String attemptId,
                                                       Storefront.CartCompletionAttemptResultQueryDefinition queryDef)

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

collection

public Storefront.QueryRootQuery collection(Storefront.CollectionQueryDefinition queryDef)

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

collection

public Storefront.QueryRootQuery collection(Storefront.QueryRootQuery.CollectionArgumentsDefinition argsDef,
                                            Storefront.CollectionQueryDefinition queryDef)

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

collectionByHandle

@Deprecated
public Storefront.QueryRootQuery collectionByHandle(java.lang.String handle,
                                                                Storefront.CollectionQueryDefinition queryDef)

Deprecated. Use `collection` instead.

Find a collection by its handle.

collections

public Storefront.QueryRootQuery collections(Storefront.CollectionConnectionQueryDefinition queryDef)

List of the shop’s collections.

collections

public Storefront.QueryRootQuery collections(Storefront.QueryRootQuery.CollectionsArgumentsDefinition argsDef,
                                             Storefront.CollectionConnectionQueryDefinition queryDef)

List of the shop’s collections.

customer

public Storefront.QueryRootQuery customer(java.lang.String customerAccessToken,
                                          Storefront.CustomerQueryDefinition queryDef)

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

public Storefront.QueryRootQuery localization(Storefront.LocalizationQueryDefinition queryDef)

Returns the localized experiences configured for the shop.

locations

public Storefront.QueryRootQuery locations(Storefront.LocationConnectionQueryDefinition queryDef)

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

public Storefront.QueryRootQuery locations(Storefront.QueryRootQuery.LocationsArgumentsDefinition argsDef,
                                           Storefront.LocationConnectionQueryDefinition queryDef)

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

public Storefront.QueryRootQuery menu(java.lang.String handle,
                                      Storefront.MenuQueryDefinition queryDef)

Retrieve a [navigation menu](https://help.shopify.com/manual/online-store/menus-and-links) by its handle.

metaobject

public Storefront.QueryRootQuery metaobject(Storefront.MetaobjectQueryDefinition queryDef)

Fetch a specific Metaobject by one of its unique identifiers.

metaobject

public Storefront.QueryRootQuery metaobject(Storefront.QueryRootQuery.MetaobjectArgumentsDefinition argsDef,
                                            Storefront.MetaobjectQueryDefinition queryDef)

Fetch a specific Metaobject by one of its unique identifiers.

metaobjects

public Storefront.QueryRootQuery metaobjects(java.lang.String type,
                                             Storefront.MetaobjectConnectionQueryDefinition queryDef)

All active metaobjects for the shop.

metaobjects

public Storefront.QueryRootQuery metaobjects(java.lang.String type,
                                             Storefront.QueryRootQuery.MetaobjectsArgumentsDefinition argsDef,
                                             Storefront.MetaobjectConnectionQueryDefinition queryDef)

All active metaobjects for the shop.

node

public Storefront.QueryRootQuery node(ID id,
                                      Storefront.NodeQueryDefinition queryDef)

Returns a specific node by ID.

nodes

public Storefront.QueryRootQuery nodes(java.util.List<ID> ids,
                                       Storefront.NodeQueryDefinition queryDef)

Returns the list of nodes with the given IDs.

page

public Storefront.QueryRootQuery page(Storefront.PageQueryDefinition queryDef)

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

page

public Storefront.QueryRootQuery page(Storefront.QueryRootQuery.PageArgumentsDefinition argsDef,
                                      Storefront.PageQueryDefinition queryDef)

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

pageByHandle

@Deprecated
public Storefront.QueryRootQuery pageByHandle(java.lang.String handle,
                                                          Storefront.PageQueryDefinition queryDef)

Deprecated. Use `page` instead.

Find a page by its handle.

pages

public Storefront.QueryRootQuery pages(Storefront.PageConnectionQueryDefinition queryDef)

List of the shop's pages.

pages

public Storefront.QueryRootQuery pages(Storefront.QueryRootQuery.PagesArgumentsDefinition argsDef,
                                       Storefront.PageConnectionQueryDefinition queryDef)

List of the shop's pages.

predictiveSearch

public Storefront.QueryRootQuery predictiveSearch(java.lang.String query,
                                                  Storefront.PredictiveSearchResultQueryDefinition queryDef)

List of the predictive search results.

predictiveSearch

public Storefront.QueryRootQuery predictiveSearch(java.lang.String query,
                                                  Storefront.QueryRootQuery.PredictiveSearchArgumentsDefinition argsDef,
                                                  Storefront.PredictiveSearchResultQueryDefinition queryDef)

List of the predictive search results.

product

public Storefront.QueryRootQuery product(Storefront.ProductQueryDefinition queryDef)

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

product

public Storefront.QueryRootQuery product(Storefront.QueryRootQuery.ProductArgumentsDefinition argsDef,
                                         Storefront.ProductQueryDefinition queryDef)

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

productByHandle

@Deprecated
public Storefront.QueryRootQuery productByHandle(java.lang.String handle,
                                                             Storefront.ProductQueryDefinition queryDef)

Deprecated. Use `product` instead.

Find a product by its handle.

productRecommendations

public Storefront.QueryRootQuery productRecommendations(Storefront.ProductQueryDefinition queryDef)

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).

productRecommendations

public Storefront.QueryRootQuery productRecommendations(Storefront.QueryRootQuery.ProductRecommendationsArgumentsDefinition argsDef,
                                                        Storefront.ProductQueryDefinition queryDef)

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).

productTags

public Storefront.QueryRootQuery productTags(int first,
                                             Storefront.StringConnectionQueryDefinition queryDef)

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

productTypes

public Storefront.QueryRootQuery productTypes(int first,
                                              Storefront.StringConnectionQueryDefinition queryDef)

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

products

public Storefront.QueryRootQuery products(Storefront.ProductConnectionQueryDefinition queryDef)

List of the shop’s products. For storefront search, use [`search` query](https://shopify.dev/docs/api/storefront/latest/queries/search).

products

public Storefront.QueryRootQuery products(Storefront.QueryRootQuery.ProductsArgumentsDefinition argsDef,
                                          Storefront.ProductConnectionQueryDefinition queryDef)

List of the shop’s products. For storefront search, use [`search` query](https://shopify.dev/docs/api/storefront/latest/queries/search).

publicApiVersions

public Storefront.QueryRootQuery publicApiVersions(Storefront.ApiVersionQueryDefinition queryDef)

The list of public Storefront API versions, including supported, release candidate and unstable versions.

search

public Storefront.QueryRootQuery search(java.lang.String query,
                                        Storefront.SearchResultItemConnectionQueryDefinition queryDef)

List of the search results.

search

public Storefront.QueryRootQuery search(java.lang.String query,
                                        Storefront.QueryRootQuery.SearchArgumentsDefinition argsDef,
                                        Storefront.SearchResultItemConnectionQueryDefinition queryDef)

List of the search results.

shop

public Storefront.QueryRootQuery shop(Storefront.ShopQueryDefinition queryDef)

The shop associated with the storefront access token.

urlRedirects

public Storefront.QueryRootQuery urlRedirects(Storefront.UrlRedirectConnectionQueryDefinition queryDef)

A list of redirects for a shop.

urlRedirects

public Storefront.QueryRootQuery urlRedirects(Storefront.QueryRootQuery.UrlRedirectsArgumentsDefinition argsDef,
                                              Storefront.UrlRedirectConnectionQueryDefinition queryDef)

A list of redirects for a shop.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object