Blog

Required access

unauthenticated_read_content access scope

Show definition
type Blog implements Node {
  # Find an article by its handle.
  articleByHandle(
    # The handle of the article.
    handle: String!
  ): Article

  # List of the blog'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](https://help.shopify.com/api/getting-started/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!

  # The authors who have contributed to the blog.
  authors: [ArticleAuthor!]!

  # A human-friendly unique string for the Blog automatically generated from its title.
  handle: String!

  # Globally unique identifier.
  id: ID!

  # The blogs’s title.
  title: String!

  # The url pointing to the blog accessible from the web.
  url: URL!
}

Implements

Connections

articles   (ArticleConnection!)

List of the blog'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.

Fields

articleByHandle   (Article)

Find an article by its handle.

Argument Type Default Description
handle

required

String!

The handle of the article.

authors   ([ArticleAuthor!]!)

The authors who have contributed to the blog.

handle   (String!)

A human-friendly unique string for the Blog automatically generated from its title.

id   (ID!)

Globally unique identifier.

title   (String!)

The blogs’s title.

url   (URL!)

The url pointing to the blog accessible from the web.

Sign up for a Partner account to get started.

Sign up