Skip to Content

Article

Represents an article object with content, author, and comment information.

Type Definition

type Article { seoDescription: String seoTitle: String seoKeywords: String handle: String headerImage: String author: Author id: Int title: String content: String summary: String comments: [Comment] commentsCount: Int blog: Blog isPublished: Boolean commentsAreEnabled: Boolean commentsRequireAccount: Boolean commentsRequireApproval: Boolean accountOwner: Boolean url: String createdAt: String updatedAt: String }

Fields

FieldTypeDescription
seoDescriptionStringReturns description for search engines.
seoTitleStringReturns title for search engines.
seoKeywordsStringReturns keywords for search engines.
handleStringRetrieve a handle for this article.
headerImageStringRetrieve the associated header image URL for this article.
authorAuthorReturns information about the article’s author as an AuthorDrop.
idIntGet the identifier for this article.
titleStringReturns the title.
contentStringGet the content of this article.
summaryStringReturns the summary (max. 140 characters) for this article.
comments[Comment]List of published comments for this article. Empty if comments are disabled.
commentsCountIntNumber of published comments for this article.
blogBlogThe blog object this article belongs to.
isPublishedBooleanWhether this article is published (unpublished articles are visible in design mode).
commentsAreEnabledBooleanWhether commenting is enabled for this article.
commentsRequireAccountBooleanWhether commenting requires a customer account.
commentsRequireApprovalBooleanWhether comments require approval for this article.
accountOwnerBooleanReturns true if the author is the owner of the store.
urlStringReturns the URL for this product group.
createdAtStringReturns the timestamp when the article was published.
updatedAtStringReturns the timestamp when the article was updated or modified.

Relationships

The Article type represents a published or draft article within a blog. Each article belongs to a Blog and contains metadata for search engine optimization. Articles can have an associated Author and a collection of published Comment objects if commenting is enabled. The article’s SEO fields provide metadata for search engines, while the handle and URL fields provide accessible identifiers for the article.

Example

query { article(id: 12345) { id title content summary handle url seoTitle seoDescription seoKeywords author { name } blog { title } comments { id body } commentsCount isPublished createdAt updatedAt } }

Implements

None