Lists the shop's articles with titles, content, authorship, and publication state.

Table-Specific Information

Select

The server uses the Shopify API to process WHERE clause conditions built with the following columns and operators. The server processes other filters client-side within the server.

• Id supports the '=, IN' comparison operators.
• Handle supports the '=, !=' comparison operators.
• AuthorName supports the '=, !=' comparison operators.
• BlogId supports the '=, !=, <, >, >=, <=' comparison operators.
• BlogTitle supports the '=, !=' comparison operators.
• IsPublished supports the '=, !=' comparison operators.
• PublishedAt supports the '=, !=, <, >, >=, <=' comparison operators.
• UpdatedAt supports the '=, !=, <, >, >=, <=' comparison operators.
• CreatedAt supports the '=, !=, <, >, >=, <=' comparison operators.

For example, the following queries are processed server-side:

  SELECT * FROM Articles WHERE Id = 'Val1'
  SELECT * FROM Articles WHERE Handle = 'Val1'
  SELECT * FROM Articles WHERE AuthorName = 'Val1'
  SELECT * FROM Articles WHERE BlogId = 'Val1'
  SELECT * FROM Articles WHERE BlogTitle = 'Val1'
  SELECT * FROM Articles WHERE IsPublished = true
  SELECT * FROM Articles WHERE PublishedAt = '2023-01-01 11:10:00'
  SELECT * FROM Articles WHERE UpdatedAt = '2023-01-01 11:10:00'
  SELECT * FROM Articles WHERE CreatedAt = '2023-01-01 11:10:00'

Insert

The following columns can be used to create a new record:

Title, Body, Handle, Summary, Tags, TemplateSuffix, AuthorName, BlogId, BlogTitle, ImageAltText, ImageUrl, PublishedAt

The following pseudo-columns can be used to create a new record:

AuthorUserId, Metafields (references Metafields)

Metafields Temporary Table Columns

Column Name	Type	Description
Id	String	The unique ID of the metafield.
Namespace	String	A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps.
Key	String	The name of the metafield.
Value	String	The information to be stored as metadata.
Type	String	The metafield's information type.

Update

The following columns can be updated:

Title, Body, Handle, Summary, Tags, TemplateSuffix, AuthorName, BlogId, BlogTitle, ImageAltText, ImageUrl, IsPublished, PublishedAt

The following pseudo-columns can be used to update a record:

AuthorUserId, RedirectNewHandle, Metafields (references Metafields)

Metafields Temporary Table Columns

Column Name	Type	Description
Id	String	The unique ID of the metafield.
Namespace	String	A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps.
Key	String	The name of the metafield.
Value	String	The information to be stored as metadata.
Type	String	The metafield's information type.

Delete

You can delete entries by specifying the following column:

Id

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The globally unique identifier of the article.
Title	String	False		The title of the article as displayed in the blog.
Body	String	False		The full body content of the article, including HTML markup.
Handle	String	False		A unique, human-readable string generated from the article title and used in the article's URL.
Summary	String	False		A short summary of the article, which can include HTML markup. The summary is displayed by the online store theme on pages such as the home page or main blog page.
Tags	String	False		Short descriptive tags associated with the article for categorization and search.
TemplateSuffix	String	False		The name of the alternate template applied to the article. Returns null if the default 'article.liquid' template is used.
AuthorName	String	False		The full name of the article's author.
BlogId	String	False		The globally unique identifier of the blog that contains this article.
BlogTitle	String	False		The title of the blog that contains this article.
ImageId	String	True		The unique identifier of the image associated with the article.
ImageAltText	String	False		Alternative text describing the content or purpose of the article's image.
ImageUrl	String	False		The URL of the article's image.
ImageWidth	Int	True		The original width of the article's image in pixels. Returns null if the image is not hosted by Shopify.
ImageHeight	Int	True		The original height of the article's image in pixels. Returns null if the image is not hosted by Shopify.
CommentsCount	Int	True		The total number of comments posted on the article.
CommentPrecision	String	True		The level of precision applied to the comment count value.
IsPublished	Bool	False		Indicates whether the article is currently published and visible.
PublishedAt	Datetime	False		The date and time when the article became visible. Returns null if the article is not published.
UpdatedAt	Datetime	True		The date and time when the article was last updated.
CreatedAt	Datetime	True		The date and time when the article was created.

Pseudo-Columns

Pseudo-columns are fields that can only be used in the types of statements under which they are explicitly listed. They are not standard columns but instead provide additional functionality for specific operations.

Name	Type	Description
AuthorUserId	String	The identifier of the staff account associated with the article's author.
RedirectNewHandle	Bool	Indicates whether a redirect is automatically created when the article handle changes. If true, the old handle redirects to the new one.
Metafields	String	The metafield input values used to create or update additional metadata for the article.