Article
Requires access scope or
access scope.
An article in the blogging system.
Anchor to Fields and connectionsFields and connections
- •Article
Author 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•Comment
Connection! non-null List of the article's comments.
- Anchor to commentsCountcomments•Count
Count Count of comments. Limited to a maximum of 10000 by default.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time (ISO 8601 format) when the article was created.
- Anchor to defaultCursordefault•String!
Cursor non-null A default cursor that returns the single next record, sorted ascending by ID.
- 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.
- •ID!non-null
A globally-unique ID.
- Anchor to imageimage•Image
The image associated with the article.
- Anchor to isPublishedis•Boolean!
Published non-null Whether or not the article is visible.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespace
andkey
, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to metafieldsmetafields•Metafield
Connection! non-null A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to metafieldsByIdentifiersmetafields•[Metafield]!
By Identifiers non-null The metafields associated with the resource matching the supplied list of namespaces and keys.
- Anchor to publishedAtpublished•Date
At Time 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.
- •[String!]!non-null
A comma-separated list of tags. Tags are additional short descriptors formatted as a string of comma-separated values.
- Anchor to templateSuffixtemplate•String
Suffix 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 isnull
.- 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 updatedAtupdated•Date
At Time The date and time (ISO 8601 format) when the article was last updated.
- Anchor to metafieldDefinitionsmetafield•Metafield
Definitions Definition Connection! non-nullDeprecated
Anchor to QueriesQueries
- •query
Returns an Article resource by ID.
- •query
List of the shop's articles.
Anchor to MutationsMutations
- •mutation
Creates an article.
- Anchor to articlearticle•Article
Create Input! required The properties of the new article.
- Anchor to blogblog•Article
Blog Input The properties of the new blog.
Arguments
- Anchor to articlearticle•Article
The article that was created.
- Anchor to userErrorsuser•[Article
Errors Create User Error!]! non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates an article.
- Anchor to articlearticle•Article
Update Input! required The properties of the article to be updated.
- Anchor to blogblog•Article
Blog Input The properties of the blog to be created.
- •ID!required
The ID of the article to be updated.
Arguments
- Anchor to articlearticle•Article
The article that was updated.
- Anchor to userErrorsuser•[Article
Errors Update User Error!]! non-null The list of errors that occurred from executing the mutation.
Fields
Anchor to InterfacesInterfaces
- •interface
- •interface
- •interface
- •interface