QueryRoot

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

Show definition

# The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start.
type QueryRoot {
  # List of the shop's articles.
  articles(
    # Returns the elements that come after the specified cursor.
    after: String

# Returns the elements that come before the specified cursor. before: String

# Returns up to the first n elements from the list. first: Int

# Returns up to the last n elements from the list. last: Int

# Supported filter parameters: # - author # - blog_title # - created_at # - tag # - updated_at # # See the detailed search syntax. query: String

# Reverse the order of the underlying list. reverse: Boolean = false

# Sort the underlying list by the given key. sortKey: ArticleSortKeys = ID ): ArticleConnection!

# Find a blog by its handle. blogByHandle( # The handle of the blog. handle: String! ): Blog

# List of the shop's blogs. blogs( # Returns the elements that come after the specified cursor. after: String

# Returns the elements that come before the specified cursor. before: String

# Returns up to the first n elements from the list. first: Int

# Returns up to the last n elements from the list. last: Int

# Supported filter parameters: # - created_at # - handle # - title # - updated_at # # See the detailed search syntax. query: String

# Reverse the order of the underlying list. reverse: Boolean = false

# Sort the underlying list by the given key. sortKey: BlogSortKeys = ID ): BlogConnection!

# Find a collection by its handle. collectionByHandle( # The handle of the collection. handle: String! ): Collection

# List of the shop’s collections. collections( # Returns the elements that come after the specified cursor. after: String

# Returns the elements that come before the specified cursor. before: String

# Returns up to the first n elements from the list. first: Int

# Returns up to the last n elements from the list. last: Int

# Supported filter parameters: # - collection_type # - title # - updated_at # # See the detailed search syntax. query: String

# Reverse the order of the underlying list. reverse: Boolean = false

# Sort the underlying list by the given key. sortKey: CollectionSortKeys = ID ): CollectionConnection! customer( # The customer access token customerAccessToken: String! ): Customer node( # The ID of the Node to return. id: ID! ): Node nodes( # The IDs of the Nodes to return. ids: [ID!]! ): [Node]!

# Find a page by its handle. pageByHandle( # The handle of the page. handle: String! ): Page

# List of the shop's pages. pages( # Returns the elements that come after the specified cursor. after: String

# Returns the elements that come before the specified cursor. before: String

# Returns up to the first n elements from the list. first: Int

# Returns up to the last n elements from the list. last: Int

# Supported filter parameters: # - created_at # - handle # - title # - updated_at # # See the detailed search syntax. query: String

# Reverse the order of the underlying list. reverse: Boolean = false

# Sort the underlying list by the given key. sortKey: PageSortKeys = ID ): PageConnection!

# Find a product by its handle. productByHandle( # The handle of the product. handle: String! ): Product

# Tags added to products. # Additional access scope required: unauthenticated_read_product_tags. productTags( # Returns up to the first n elements from the list. first: Int! ): StringConnection!

# List of the shop’s product types. productTypes( # Returns up to the first n elements from the list. first: Int! ): StringConnection!

# List of the shop’s products. products( # Returns the elements that come after the specified cursor. after: String

# Returns the elements that come before the specified cursor. before: String

# Returns up to the first n elements from the list. first: Int

# Returns up to the last n elements from the list. last: Int

# Supported filter parameters: # - available_for_sale # - created_at # - product_type # - tag # - title # - updated_at # - variants.price # - vendor # # See the detailed search syntax. query: String

# Reverse the order of the underlying list. reverse: Boolean = false

# Sort the underlying list by the given key. sortKey: ProductSortKeys = ID ): ProductConnection! shop: Shop! }

Connections

articles   (ArticleConnection!)

List of the shop's articles.

Argument Type Default Description
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

false

Reverse the order of the underlying list.

sortKey

ArticleSortKeys

ID

Sort the underlying list by the given key.

blogs   (BlogConnection!)

List of the shop's blogs.

Argument Type Default Description
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

false

Reverse the order of the underlying list.

sortKey

BlogSortKeys

ID

Sort the underlying list by the given key.

collections   (CollectionConnection!)

List of the shop’s collections.

Argument Type Default Description
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

false

Reverse the order of the underlying list.

sortKey

CollectionSortKeys

ID

Sort the underlying list by the given key.

pages   (PageConnection!)

List of the shop's pages.

Argument Type Default Description
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

false

Reverse the order of the underlying list.

sortKey

PageSortKeys

ID

Sort the underlying list by the given key.

productTags   (StringConnection!)

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

Required access

unauthenticated_read_product_tags access scope

Argument Type Default Description
first

required

Int!

Returns up to the first n elements from the list.

productTypes   (StringConnection!)

List of the shop’s product types.

Required access

unauthenticated_read_product_listings access scope

Argument Type Default Description
first

required

Int!

Returns up to the first n elements from the list.

products   (ProductConnection!)

List of the shop’s products.

Argument Type Default Description
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

false

Reverse the order of the underlying list.

sortKey

ProductSortKeys

ID

Sort the underlying list by the given key.

Fields

blogByHandle   (Blog)

Find a blog by its handle.

Argument Type Default Description
handle

required

String!

The handle of the blog.

collectionByHandle   (Collection)

Find a collection by its handle.

Argument Type Default Description
handle

required

String!

The handle of the collection.

customer   (Customer)

Argument Type Default Description
customerAccessToken

required

String!

The customer access token

node   (Node)

Argument Type Default Description
id

required

ID!

The ID of the Node to return.

nodes   ([Node]!)

Argument Type Default Description
ids

required

[ID!]!

The IDs of the Nodes to return.

pageByHandle   (Page)

Find a page by its handle.

Argument Type Default Description
handle

required

String!

The handle of the page.

productByHandle   (Product)

Find a product by its handle.

Argument Type Default Description
handle

required

String!

The handle of the product.

shop   (Shop!)

Sign up for a Partner account to get started.

Sign up