Choose a version:

Article

object

Requires unauthenticated_read_content access scope.

A post that belongs to a Blog. Each article includes content with optional HTML formatting, an excerpt for previews, ArticleAuthor information, and an associated Image.

Articles can be organized with tags and include SEO metadata. You can manage comments when the blog's comment policy enables them.

Anchor to FieldsFields

Anchor to authorV2authorV2

•ArticleAuthor

The article's author.

Anchor to blogblog

•Blog!

non-null

The blog that the article belongs to.

Anchor to commentscomments

•CommentConnection!

non-null

List of comments posted on the article.

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 contentcontent

•String!

non-null

Stripped content of the article, single line with HTML tags removed.

Anchor to truncateAttruncateAt •Int: Truncates a string after the given length.

Anchor to contentHtmlcontentHtml

•HTML!

non-null

The content of the article, complete with HTML formatting.

Anchor to excerptexcerpt

•String

Stripped excerpt of the article, single line with HTML tags removed.

Anchor to truncateAttruncateAt •Int: Truncates a string after the given length.

Anchor to excerptHtmlexcerptHtml

•HTML

The excerpt of the article, complete with HTML formatting.

Anchor to handlehandle

•String!

non-null

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

Anchor to idid

•ID!

non-null

A globally-unique ID.

Anchor to imageimage

•Image

The image associated with the article.

Anchor to metafieldmetafield

•Metafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
Anchor to keykey •String! required: The identifier for the metafield.

Anchor to metafieldsmetafields

•[Metafield]!

non-null

A list of custom fields that a merchant associates with a Shopify resource.

Arguments

Anchor to identifiersidentifiers

•[HasMetafieldsIdentifier!]!

required

The list of metafields to retrieve by namespace and key.

The input must not contain more than 250 values.

Anchor to onlineStoreUrlonlineStoreUrl

•URL

The URL used for viewing the resource on the shop's Online Store. Returns null if the resource is currently not published to the Online Store sales channel.

Anchor to publishedAtpublishedAt

•DateTime!

non-null

The date and time when the article was published.

Anchor to seoseo

•SEO

The article’s SEO information.

Anchor to tagstags

•[String!]!

non-null

A categorization that a article can be tagged with.

Anchor to titletitle

•String!

non-null

The article’s name.

Anchor to trackingParameterstrackingParameters

•String

URL parameters to be added to a page URL to track the origin of on-site search traffic for analytics reporting. Returns a result when accessed through the search or predictiveSearch queries, otherwise returns null.

Anchor to authorauthor

•ArticleAuthor!

non-nullDeprecated

Was this section helpful?

Anchor to QueriesQueries

Anchor to article article

•query

Returns an Article by its ID. Each article belongs to a Blog and includes content in both plain text and HTML formats, ArticleAuthor information, Comment objects, tags, and SEO data.

Anchor to idid •ID! required: The ID of the Article.

Anchor to articles articles

•query

Returns a paginated list of Article objects from the shop's Blog objects. Each article is a blog post containing content, author information, tags, and optional images.

Use the query argument to filter results by author, blog title, tags, or date fields. Sort results using the sortKey argument and reverse them with the reverse argument.