GitHub

ShopifyArticle

interface

import { ShopifyArticle } from '@daffodil/driver/shopify'

An article in an online store blog.

interface ShopifyArticle {
  __typename: "Article"
  author: ShopifyArticleAuthor
  authorV2: ShopifyArticleAuthor
  blog: ShopifyBlog
  comments: ShopifyCommentConnection
  content: string
  contentHtml: Scalars['HTML']['output']
  excerpt: string
  excerptHtml: Maybe<Scalars['HTML']['output']>
  handle: string
  id: string
  image: ShopifyImage
  metafield: ShopifyMetafield
  metafields: ShopifyMetafield[]
  onlineStoreUrl: Maybe<Scalars['URL']['output']>
  publishedAt: Scalars['DateTime']['output']
  seo: ShopifySeo
  tags: string[]
  title: string
  trackingParameters: string
}

Properties

__typename
"Article"
author
ShopifyArticleAuthor

The article's author.

authorV2
ShopifyArticleAuthor

The article's author.

blog
ShopifyBlog

The blog that the article belongs to.

comments
ShopifyCommentConnection

List of comments posted on the article.

content
string

Stripped content of the article, single line with HTML tags removed.

contentHtml
Scalars['HTML']['output']

The content of the article, complete with HTML formatting.

excerpt
string

Stripped excerpt of the article, single line with HTML tags removed.

excerptHtml
Maybe<Scalars['HTML']['output']>

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
string

A globally-unique ID.

image
ShopifyImage

The image associated with the article.

metafield
ShopifyMetafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

metafields
ShopifyMetafield[]

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

onlineStoreUrl
Maybe<Scalars['URL']['output']>

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
Scalars['DateTime']['output']

The date and time when the article was published.

seo
ShopifySeo

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. Returns a result when accessed through the search or predictiveSearch queries, otherwise returns null.