Cmdlets for Shopify

Build 24.0.9060

Articles

Returns a list of the shop's visible articles.

View-Specific Information

Select

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

  • Id supports the '=,IN' comparison operators.
  • AuthorV2Name supports the '=,!=' comparison operators.
  • AuthorV2FirstName supports the '=,!=' comparison operators.
  • AuthorV2LastName supports the '=,!=' comparison operators.
  • BlogTitle supports the '=,!=' comparison operators.
  • CreatedAt supports the '=,!=,<,>,>=,<=' comparison operators.
  • UpdatedAt supports the '=,!=,<,>,>=,<=' comparison operators.

For example, the following queries are processed server side:

  SELECT * FROM Articles
  SELECT * FROM Articles WHERE Id = 'Val1'
  SELECT * FROM Articles WHERE AuthorV2Name = 'Val1'
  SELECT * FROM Articles WHERE AuthorV2FirstName = 'Val1'
  SELECT * FROM Articles WHERE AuthorV2LastName = 'Val1'
  SELECT * FROM Articles WHERE BlogTitle = 'Val1'
  SELECT * FROM Articles WHERE CreatedAt = '2023-01-01 11:10:00'
  SELECT * FROM Articles WHERE UpdatedAt = '2023-01-01 11:10:00'

Columns

Name Type References Description
Id [KEY] String A globally-unique ID.
Title String The article's name.
Handle String A human-friendly unique string for the Article automatically generated from its title.
Tags String A categorization that a article can be tagged with.
ContentHtml String The content of the article, complete with HTML formatting.
ExcerptHtml String The excerpt of the article, complete with HTML formatting.
OnlineStoreUrl String 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.
AuthorV2Name String The author's full name.
AuthorV2FirstName String The author's first name.
AuthorV2LastName String The author's last name.
AuthorV2Bio String The author's bio.
AuthorV2Email String The author's email.
BlogId String A globally-unique ID.
BlogTitle String The blogs's title.
ImageId String A unique ID for the image.
ImageWidth Int The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
ImageAltText String A word or phrase to share the nature or contents of an image.
ImageHeight Int The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify.
ImageUrl String The location of the image as a URL.
SeoTitle String The SEO title.
SeoDescription String The meta description.
CreatedAt Datetime The date and time when the article was created. This column can only be used as an input for filtering.
UpdatedAt Datetime The date and time when the article was last updated. This column can only be used as an input for filtering.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060