CData Python Connector for Shopify

Build 23.0.8839

Collections

Returns a list of collections.

Table-Specific Information

Select

The connector uses the Shopify API to process WHERE clause conditions built with the following columns and operators:

  • Id supports the '=,IN' comparison operators.
  • Title supports the '=,!=' comparison operators.
  • UpdatedAt supports the '=,!=,<,>,>=,<=' comparison operators.

The connector processes other filters client-side within the connector.

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

SELECT * FROM Collections WHERE Id='VALUE'

SELECT * FROM Collections WHERE Title='VALUE'

SELECT * FROM Collections WHERE UpdatedAt<'2000-01-01 01:00:00.0'

UPDATE

UPDATE statements are mapped to the 'collectionUpdate' GraphQL mutation.

The following column can be updated:

SortOrder

Columns

Name Type ReadOnly References Description
Id [KEY] String True

A globally-unique ID.

LegacyResourceId String True

The ID of the corresponding resource in the REST Admin API.

Title String True

The name of the collection. It's displayed in the Shopify admin and is typically displayed in sales channels, such as an online store.

Handle String True

A unique string that identifies the collection. If a handle isn't specified when a collection is created, it's automatically generated from the collection's original title, and typically includes words from the title separated by hyphens. For example, a collection that was created with the title 'Summer Catalog 2022' might have the handle 'summer-catalog-2022'. If the title is changed, the handle doesn't automatically change. The handle can be used in themes by the Liquid templating language to refer to the collection, but using the ID is preferred because it never changes.

DescriptionHtml String True

The description of the collection, including any HTML tags and formatting. This content is typically displayed to customers, such as on an online store, depending on the theme.

ProductsCount Int True

The number of products in the collection.

SortOrder String False

The order in which the products in the collection are displayed by default in the Shopify admin and in sales channels, such as an online store.

TemplateSuffix String True

The suffix of the Liquid template being used to show the collection in an online store. For example, if the value is 'custom', then the collection is using the 'collection. custom. liquid' template. If the value is 'null', then the collection is using the default 'collection. liquid' template.

AvailablePublicationCount Int True

The number of publications a resource is published to without feedback errors.

PublishedOnCurrentPublication Bool True

Check to see whether the resource is published to the calling app's publication.

UpdatedAt Datetime True

The date and time when the collection was last modified.

FeedbackSummary String True

Summary of resource feedback pertaining to the resource.

ImageId String True

A unique ID for the image.

ImageWidth Int True

The original width of the image in pixels. Returns 'null' if the image is not hosted by Shopify.

ImageAltText String True

A word or phrase to share the nature or contents of an image.

ImageHeight Int True

The original height of the image in pixels. Returns 'null' if the image is not hosted by Shopify.

ImageUrl String True

The location of the image as a URL.

RuleSetAppliedDisjunctively Bool True

Whether products must match any or all of the rules to be included in the collection. If true, then products must match at least one of the rules to be included in the collection. If false, then products must match all of the rules to be included in the collection.

SeoTitle String True

SEO Title.

SeoDescription String True

SEO Description.

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