CData Python Connector for Shopify

Build 25.0.9454

Articles

Contains article content for the shop's blogs, including titles, handles, authors, and publication details.

Table-Specific Information

Select

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

  • Id supports the '=, IN' comparison operators.
  • AuthorName supports the '=, !=' comparison operators.
  • BlogTitle supports the '=, !=' comparison operators.
  • IsPublished 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 AuthorName = 'Val1'
  SELECT * FROM Articles WHERE BlogTitle = 'Val1'
  SELECT * FROM Articles WHERE IsPublished = true
  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 NameTypeDescription
IdStringThe unique ID of the metafield.
NamespaceStringA 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.
KeyStringThe name of the metafield.
ValueStringThe information to be stored as metadata.
TypeStringThe 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 NameTypeDescription
IdStringThe unique ID of the metafield.
NamespaceStringA 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.
KeyStringThe name of the metafield.
ValueStringThe information to be stored as metadata.
TypeStringThe 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

A unique identifier for the article record.

Title String False

The title of the article as displayed on the online store or within the Shopify Admin.

Body String False

The full HTML-formatted body content of the article, including text and markup elements.

Handle String False

A unique, URL-friendly identifier automatically generated from the article's title, used to form the article's web address.

Summary String False

A short HTML-supported excerpt of the article, commonly used in previews or blog listing pages within store themes.

Tags String False

A set of short descriptive keywords associated with the article, used for filtering and categorization.

TemplateSuffix String False

Specifies the alternate Liquid template assigned to this article. Returns null if the default 'article.liquid' template is used.

AuthorName String False

The full name of the person credited as the author of the article.

BlogId String False

The unique identifier of the blog that contains this article.

BlogTitle String False

The title of the blog where this article is published.

ImageId String True

The unique identifier of the primary image associated with the article.

ImageAltText String False

A brief text description of the article's image, used for accessibility and SEO.

ImageUrl String False

The direct URL where the article's image is hosted.

ImageWidth Int True

The width of the article's image in pixels. Returns null if the image isn't hosted by Shopify.

ImageHeight Int True

The height of the article's image in pixels. Returns null if the image isn't hosted by Shopify.

CommentsCount Int True

The total number of comments associated with the article.

CommentPrecision String True

Indicates the precision level of the comment count, showing whether the number is exact or estimated.

IsPublished Bool False

Indicates whether the article is currently published and visible on the storefront.

PublishedAt Datetime False

The date and time when the article was or will be made visible to the public. Returns null if the article is unpublished.

UpdatedAt Datetime True

The timestamp indicating when the article was most recently edited or updated.

CreatedAt Datetime True

The timestamp indicating when the article was originally 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 unique identifier of the staff account associated with the article's author, if applicable.

RedirectNewHandle Bool

Indicates whether Shopify automatically redirects the old article URL to a new handle after it's changed.

Metafields String

Metadata fields that store custom information about the article, used to extend article properties or add structured data.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9454