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 commentsCountcommentsCount •Count: Count of comments.
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.
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 metafieldsmetafields •MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
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 updatedAtupdatedAt •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 QueriesQueries

Anchor to article article •query: Returns a Article resource by ID.
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.

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

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to HasEvents HasEvents •interface
Anchor to HasMetafieldDefinitions HasMetafieldDefinitions •interface
Anchor to HasMetafields HasMetafields •interface
Anchor to HasPublishedTranslations HasPublishedTranslations •interface
Anchor to Navigable Navigable •interface
Anchor to Node Node •interface

Was this section helpful?