Choose a version:

Article

object

Requires read_content access scope or read_online_store_pages access scope.

An article that contains content, author information, and metadata. Articles belong to a Blog and can include HTML-formatted body text, summary text, and an associated image. Merchants publish articles to share content, drive traffic, and engage customers.

Articles can be organized with tags and published immediately or scheduled for future publication using the publishedAt timestamp. The API manages comments on articles when the blog's comment policy enables them.

Anchor to FieldsFields

Anchor to authorauthor

•ArticleAuthor

The name of the author of the article.

Anchor to blogblog

•Blog!

non-null

The blog containing the article.

Anchor to bodybody

•HTML!

non-null

The text of the article's body, complete with HTML markup.

Anchor to commentscomments

•CommentConnection!

non-null

List of the article's comments.

Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to queryquery •String: A filter made up of terms, connectives, modifiers, and comparators.

name type description acceptable_values default_value example_use
default string Filter by a case-insensitive search of multiple fields
in a document. - query=Bob Norman
- query=title:green hoodie
created_at time Filter by the date and time when the comment was
created. - created_at:>'2020-10-21T23:39:20Z'
-
created_at:<now
- created_at:<=2024
id id Filter by id range. - id:1234
- id:>=1234
- id:<=1234
published_at time Filter by the date and time when the comment was
published. - published_at:>'2020-10-21T23:39:20Z'
-
published_at:<now
- published_at:<=2024
published_status string Filter by published status - any
-
published
- unpublished - published_status:any
-
published_status:published
- published_status:unpublished
status string
updated_at time Filter by the date and time when the comment was last
updated. - updated_at:>'2020-10-21T23:39:20Z'
-
updated_at:<now
- updated_at:<=2024
You can apply one or more filters to a query. Learn more about [Shopify API
search syntax](https://shopify.dev/api/usage/search-syntax).
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to commentsCountcommentsCount

•Count

Count of comments. Limited to a maximum of 10000 by default.

Anchor to limitlimit •Int Default:10000: The upper bound on count value before returning a result. Use null to have no limit.
Anchor to queryquery •String: A filter made up of terms, connectives, modifiers, and comparators.

name type description acceptable_values default_value example_use
default string Filter by a case-insensitive search of multiple fields
in a document. - query=Bob Norman
- query=title:green hoodie
created_at time Filter by the date and time when the comment was
created. - created_at:>'2020-10-21T23:39:20Z'
-
created_at:<now
- created_at:<=2024
id id Filter by id range. - id:1234
- id:>=1234
- id:<=1234
published_at time Filter by the date and time when the comment was
published. - published_at:>'2020-10-21T23:39:20Z'
-
published_at:<now
- published_at:<=2024
published_status string Filter by published status - any
-
published
- unpublished - published_status:any
-
published_status:published
- published_status:unpublished
status string
updated_at time Filter by the date and time when the comment was last
updated. - updated_at:>'2020-10-21T23:39:20Z'
-
updated_at:<now
- updated_at:<=2024
You can apply one or more filters to a query. Learn more about [Shopify API
search syntax](https://shopify.dev/api/usage/search-syntax).

Anchor to createdAtcreatedAt

•DateTime!

non-null

The date and time (ISO 8601 format) when the article was created.

Anchor to defaultCursordefaultCursor

•String!

non-null

A default cursor that returns the single next record, sorted ascending by ID.

Anchor to eventsevents

•EventConnection!

non-null

The paginated list of events associated with the host subject.

Arguments

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to queryquery

•String

Anchor to action •string: The action that occured.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•EventSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to handlehandle

•String!

non-null

A unique, human-friendly string for the article that's automatically generated from the article's title. The handle is used in the article's URL.

Anchor to idid

•ID!

non-null

A globally-unique ID.

Anchor to imageimage

•Image

The image associated with the article.

Anchor to isPublishedisPublished

•Boolean!

non-null

Whether or not the article is visible.

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 keykey •String! required: The key for the metafield.
Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.

Anchor to metafieldsmetafields

•MetafieldConnection!

non-null

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

Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, all metafields are returned.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to publishedAtpublishedAt

•DateTime

The date and time (ISO 8601 format) when the article became or will become visible. Returns null when the article isn't visible.

Anchor to summarysummary

•HTML

A summary of the article, which can include HTML markup. The summary is used by the online store theme to display the article on other pages, such as the home page or the main blog page.

Anchor to tagstags

•[String!]!

non-null

A comma-separated list of tags. Tags are additional short descriptors formatted as a string of comma-separated values.

Anchor to templateSuffixtemplateSuffix

•String

The name of the template an article is using if it's using an alternate template. If an article is using the default article.liquid template, then the value returned is null.

Anchor to titletitle

•String!

non-null

The title of the article.

Anchor to translationstranslations

•[Translation!]!

non-null

The published translations associated with the resource.

Anchor to localelocale •String! required: Filters translations locale.
Anchor to marketIdmarketId •ID: Filters translations by market ID. Use this argument to retrieve content specific to a market.

Anchor to updatedAtupdatedAt

•DateTime

The date and time (ISO 8601 format) when the article was last updated.

Anchor to metafieldDefinitionsmetafieldDefinitions

•MetafieldDefinitionConnection!

non-nullDeprecated

Arguments

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to namespacenamespace

•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus

•MetafieldDefinitionPinnedStatus

Default:ANY

Filter by the definition's pinned status.

Anchor to queryquery

•String

A filter made up of terms, connectives, modifiers, and comparators.

name	type	description	acceptable_values	example_use
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` - `query=title:green hoodie`
created_at	time	Filter by the date and time when the metafield
definition was created.			- `created_at:>2020-10-21T23:39:20Z` -
`created_at:<now` - `created_at:<=2024`
id	id	Filter by `id` range.		- `id:1234` - `id:>=1234` - `id:<=1234`
key	string	Filter by the metafield definition `key`
field.			- `key:some-key`
namespace	string	Filter by the metafield definition `namespace`
field.			- `namespace:some-namespace`
owner_type	string	Filter by the metafield definition `ownerType`
field.			- `owner_type:PRODUCT`
type	string	Filter by the metafield definition `type`
field.			- `type:single_line_text_field`
updated_at	time	Filter by the date and time when the metafield
definition was last updated.			- `updated_at:>2020-10-21T23:39:20Z`

updated_at:<now
- updated_at:<=2024 | You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•MetafieldDefinitionSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Was this section helpful?

Anchor to QueriesQueries

Anchor to article article

•query

Returns a Article resource by ID.

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

Anchor to articles articles

•query

Returns a paginated list of articles from the shop's blogs. Article objects are blog posts that contain content like text, images, and tags.

Supports cursor-based pagination to control the number of articles returned and their order. Use the query argument to filter results by specific criteria.

Arguments

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to queryquery

•String

A filter made up of terms, connectives, modifiers, and comparators.

name	type	description	acceptable_values	example_use
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` -
`query=handle:summer-collection-announcement`
author	string	Filter by the author of the article.
blog_id	string	Filter by the ID of the blog the article belongs to.
	- `blog_id:1234` - `blog_id:>=1234` - `blog_id:<=1234`
blog_title	string
created_at	time	Filter by the date and time when the article was
created.			- `created_at:>'2020-10-21T23:39:20Z'` -
`created_at:<now` - `created_at:<=2024`
handle	string	Filter by the article's handle.		-
`handle:summer-collection-announcement` - `handle:how-to-guide`
id	id	Filter by `id` range.		- `id:1234` - `id:>=1234` - `id:<=1234`
published_at	time	Filter by the date and time when the article was
published.			- `published_at:>'2020-10-21T23:39:20Z'` -
`published_at:<now` - `published_at:<=2024`
published_status	string	Filter by published status
tag	string	Filter objects by the `tag` field.		- `tag:my_tag`
tag_not	string	Filter by objects that don’t have the specified tag.		- `tag_not:my_tag`
title	string	Filter by the title of the article.		- `title:summer-collection` - `title:green hoodie`
updated_at	time	Filter by the date and time when the article was last
updated.			- `updated_at:>'2020-10-21T23:39:20Z'` -
`updated_at:<now` - `updated_at:<=2024`
You can apply one or more filters to a query. Learn more about [Shopify API
search syntax](https://shopify.dev/api/usage/search-syntax).

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•ArticleSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Was this section helpful?

Anchor to MutationsMutations

Anchor to articleCreate articleCreate

•mutation

Creates an Article. Articles are content pieces that include a title, body text, and author information.

You can publish the article immediately or schedule it with a specific publish date. You can customize the article's URL handle, apply custom templates for rendering, and add optional fields like tags, an image, and Metafield objects.

The mutation validates article content and ensures proper blog association. Error handling provides specific feedback for content requirements.

Arguments

Anchor to articlearticle

•ArticleCreateInput!

required

The properties of the new article.

Anchor to blogblog

•ArticleBlogInput

The properties of the new blog.

Anchor to articleUpdate articleUpdate

•mutation

Updates an existing Article. You can modify the article's content, metadata, publication status, and associated properties like author information and tags.

If you update the handle, then you can optionally create a redirect from the old URL to the new one by setting redirectNewHandle to true.