QueryRoot

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

Connections

articles (ArticleConnection!)

List of the shop's articles.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • author
  • blog_title
  • created_at
  • tag
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( ArticleSortKeys )

Sort the underlying list by the given key.
Default value: ID

blogs (BlogConnection!)

List of the shop's blogs.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • created_at
  • handle
  • title
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( BlogSortKeys )

Sort the underlying list by the given key.
Default value: ID

collections (CollectionConnection!)

List of the shop’s collections.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • collection_type
  • title
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( CollectionSortKeys )

Sort the underlying list by the given key.
Default value: ID

pages (PageConnection!)

List of the shop's pages.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • created_at
  • handle
  • title
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( PageSortKeys )

Sort the underlying list by the given key.
Default value: ID

productTags (StringConnection!)

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

Required access

unauthenticated_read_product_tags access scope

first ( Int! ) required

Returns up to the first n elements from the list.

productTypes (StringConnection!)

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

Required access

unauthenticated_read_product_listings access scope

first ( Int! ) required

Returns up to the first n elements from the list.

products (ProductConnection!)

List of the shop’s products.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • available_for_sale
  • created_at
  • product_type
  • tag
  • title
  • updated_at
  • variants.price
  • vendor

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( ProductSortKeys )

Sort the underlying list by the given key.
Default value: ID

Fields

blogByHandle (Blog)

Find a blog by its handle.

handle ( String! ) required

The handle of the blog.

collectionByHandle (Collection)

Find a collection by its handle.

handle ( String! ) required

The handle of the collection.

customer (Customer)
customerAccessToken ( String! ) required

The customer access token

node (Node)
id ( ID! ) required

The ID of the Node to return.

nodes ([Node]!)
ids ( [ID!]! ) required

The IDs of the Nodes to return.

pageByHandle (Page)

Find a page by its handle.

handle ( String! ) required

The handle of the page.

productByHandle (Product)

Find a product by its handle.

handle ( String! ) required

The handle of the product.

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.

productId ( ID! ) required

The id of the product.

publicApiVersions ([ApiVersion!]!)

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

shop (Shop!)

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

Connections

articles (ArticleConnection!)

List of the shop's articles.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • author
  • blog_title
  • created_at
  • tag
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( ArticleSortKeys )

Sort the underlying list by the given key.
Default value: ID

blogs (BlogConnection!)

List of the shop's blogs.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • created_at
  • handle
  • title
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( BlogSortKeys )

Sort the underlying list by the given key.
Default value: ID

collections (CollectionConnection!)

List of the shop’s collections.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • collection_type
  • title
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( CollectionSortKeys )

Sort the underlying list by the given key.
Default value: ID

pages (PageConnection!)

List of the shop's pages.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • created_at
  • handle
  • title
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( PageSortKeys )

Sort the underlying list by the given key.
Default value: ID

productTags (StringConnection!)

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

Required access

unauthenticated_read_product_tags access scope

first ( Int! ) required

Returns up to the first n elements from the list.

productTypes (StringConnection!)

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

Required access

unauthenticated_read_product_listings access scope

first ( Int! ) required

Returns up to the first n elements from the list.

products (ProductConnection!)

List of the shop’s products.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • available_for_sale
  • created_at
  • product_type
  • tag
  • title
  • updated_at
  • variants.price
  • vendor

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( ProductSortKeys )

Sort the underlying list by the given key.
Default value: ID

Fields

blogByHandle (Blog)

Find a blog by its handle.

handle ( String! ) required

The handle of the blog.

collectionByHandle (Collection)

Find a collection by its handle.

handle ( String! ) required

The handle of the collection.

customer (Customer)
customerAccessToken ( String! ) required

The customer access token

node (Node)
id ( ID! ) required

The ID of the Node to return.

nodes ([Node]!)
ids ( [ID!]! ) required

The IDs of the Nodes to return.

pageByHandle (Page)

Find a page by its handle.

handle ( String! ) required

The handle of the page.

productByHandle (Product)

Find a product by its handle.

handle ( String! ) required

The handle of the product.

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.

productId ( ID! ) required

The id of the product.

publicApiVersions ([ApiVersion!]!)

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

shop (Shop!)

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

Connections

articles (ArticleConnection!)

List of the shop's articles.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • author
  • blog_title
  • created_at
  • tag
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( ArticleSortKeys )

Sort the underlying list by the given key.
Default value: ID

blogs (BlogConnection!)

List of the shop's blogs.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • created_at
  • handle
  • title
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( BlogSortKeys )

Sort the underlying list by the given key.
Default value: ID

collections (CollectionConnection!)

List of the shop’s collections.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • collection_type
  • title
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( CollectionSortKeys )

Sort the underlying list by the given key.
Default value: ID

pages (PageConnection!)

List of the shop's pages.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • created_at
  • handle
  • title
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( PageSortKeys )

Sort the underlying list by the given key.
Default value: ID

productTags (StringConnection!)

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

Required access

unauthenticated_read_product_tags access scope

first ( Int! ) required

Returns up to the first n elements from the list.

productTypes (StringConnection!)

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

Required access

unauthenticated_read_product_listings access scope

first ( Int! ) required

Returns up to the first n elements from the list.

products (ProductConnection!)

List of the shop’s products.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • available_for_sale
  • created_at
  • product_type
  • tag
  • title
  • updated_at
  • variants.price
  • vendor

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

sortKey ( ProductSortKeys )

Sort the underlying list by the given key.
Default value: ID

Fields

blogByHandle (Blog)

Find a blog by its handle.

handle ( String! ) required

The handle of the blog.

collectionByHandle (Collection)

Find a collection by its handle.

handle ( String! ) required

The handle of the collection.

customer (Customer)
customerAccessToken ( String! ) required

The customer access token

node (Node)
id ( ID! ) required

The ID of the Node to return.

nodes ([Node]!)
ids ( [ID!]! ) required

The IDs of the Nodes to return.

pageByHandle (Page)

Find a page by its handle.

handle ( String! ) required

The handle of the page.

productByHandle (Product)

Find a product by its handle.

handle ( String! ) required

The handle of the product.

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.

productId ( ID! ) required

The id of the product.

publicApiVersions ([ApiVersion!]!)

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

shop (Shop!)

Sign up for a Partner account to get started.

Sign up