Skip to main content
object

Requires read_content access scope or read_online_store_pages access scope.

An article in the blogging system.

Anchor to Fields and connectionsFields and connections

•ArticleAuthor

The name of the author of the article.

•Blog!non-null

The blog containing the article.

•HTML!non-null

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

•CommentConnection!non-null

List of the article's comments.

•Count

Count of comments.

•DateTime!non-null

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

•String!non-null

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

•EventConnection!non-null

The paginated list of events associated with the host subject.

•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.

•ID!non-null

A globally-unique ID.

•Image

The image associated with the article.

•Boolean!non-null

Whether or not the article is visible.

•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.

•MetafieldConnection!non-null

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

•DateTime

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

•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.

•[String!]!non-null

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

•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.

•String!non-null

The title of the article.

•[Translation!]!non-null

The published translations associated with the resource.

•DateTime

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

Anchor to metafieldDefinitionsmetafieldDefinitions
•MetafieldDefinitionConnection!non-nullDeprecated

Was this section helpful?

Anchor to articlearticle
•query

Returns an Article resource by ID.

•query

List of the shop's articles.


Was this section helpful?

•mutation

Creates an article.

Arguments

•ArticleCreateInput!required

The properties of the new article.

•ArticleBlogInput

The properties of the new blog.


Fields

•Article

The article that was created.

•[ArticleCreateUserError!]!non-null

The list of errors that occurred from executing the mutation.

•mutation

Updates an article.

Arguments

•ArticleUpdateInput!required

The properties of the article to be updated.

•ArticleBlogInput

The properties of the blog to be created.

•ID!required

The ID of the article to be updated.


Fields

•Article

The article that was updated.

•[ArticleUpdateUserError!]!non-null

The list of errors that occurred from executing the mutation.


Was this section helpful?

OSZAR »