Article - storefront - OBJECT

Version: 2024-07

Description:

An article in an online store blog.

Access Scopes

`unauthenticated_read_content` access scope.

Fields

  • author: ArticleAuthor! - The article's author.
  • authorV2: ArticleAuthor - The article's author.
  • blog: Blog! - The blog that the article belongs to.
  • content: String! - Stripped content of the article, single line with HTML tags removed.
  • contentHtml: HTML! - The content of the article, complete with HTML formatting.
  • excerpt: String - Stripped excerpt of the article, single line with HTML tags removed.
  • excerptHtml: HTML - The excerpt of the article, complete with HTML formatting.
  • handle: String! - A human-friendly unique string for the Article automatically generated from its title.
  • id: ID! - A globally-unique ID.
  • image: Image - The image associated with the article.
  • metafield: Metafield - A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information.
  • metafields: Metafield! - A list of [custom fields](/docs/apps/build/custom-data) that a merchant associates with a Shopify resource.
  • onlineStoreUrl: URL - The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel.
  • publishedAt: DateTime! - The date and time when the article was published.
  • seo: SEO - The article’s SEO information.
  • tags: String! - A categorization that a article can be tagged with.
  • title: String! - The article’s name.
  • trackingParameters: String - URL parameters to be added to a page URL to track the origin of on-site search traffic for [analytics reporting](https://help.shopify.com/manual/reports-and-analytics/shopify-reports/report-types/default-reports/behaviour-reports). Returns a result when accessed through the [search](https://shopify.dev/docs/api/storefront/current/queries/search) or [predictiveSearch](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries, otherwise returns null.

Connections

  • comments: CommentConnection!

Related queries

  • article Fetch a specific Article by its ID.
  • articles List of the shop's articles.

Related mutations

Related Unions

  • MenuItemResource The list of possible resources a `MenuItem` can reference.
  • MetafieldParentResource A resource that the metafield belongs to.
  • SearchResultItem A search result that matches the search query.

Examples