Collections

Returns manual and automated collections with titles, rules, and publication state.

Table-Specific Information

Select

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

Id supports the '=, IN' comparison operators.
Title supports the '=, !=' comparison operators.
Handle supports the '=, IN' comparison operators.
UpdatedAt supports the '=, !=, <, >, >=, <=' comparison operators.
Namespace supports the '=' comparison operator.
Key supports the '=' comparison operator.
Value supports the '=' comparison operator.

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

  SELECT * FROM Collections WHERE Id = 'Val1'
  SELECT * FROM Collections WHERE Title = 'Val1'
  SELECT * FROM Collections WHERE Handle = 'Val1'
  SELECT * FROM Collections WHERE UpdatedAt = '2023-01-01 11:10:00'
  SELECT * FROM Collections WHERE Namespace = 'Val1'
  SELECT * FROM Collections WHERE Key = 'Val1'
  SELECT * FROM Collections WHERE Value = 'Val1'

Insert

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

Title, Handle, DescriptionHtml, SortOrder, TemplateSuffix, ImageAltText, ImageUrl, RuleSetRules (references CollectionRules), RuleSetAppliedDisjunctively, SeoTitle, SeoDescription

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

ProductIds, Metafields (references Metafields)

CollectionRules Temporary Table Columns


Column Name	Type	Description
Column	String	The attribute that the rule focuses on.
Relation	String	The type of operator that the rule is based on.
Condition	String	The value that the operator is applied to.
ConditionObjectMetafieldDefinitionId	String	The metafield definition used as a rule for the condition.

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, Handle, DescriptionHtml, SortOrder, TemplateSuffix, ImageAltText, ImageUrl, RuleSetRules (references CollectionRules), RuleSetAppliedDisjunctively, SeoTitle, SeoDescription

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

RedirectNewHandle

CollectionRules Temporary Table Columns


Column Name	Type	Description
Column	String	The attribute that the rule focuses on.
Relation	String	The type of operator that the rule is based on.
Condition	String	The value that the operator is applied to.
ConditionObjectMetafieldDefinitionId	String	The metafield definition used as a rule for the condition.

Delete

You can delete entries by specifying the following column:

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		The globally unique identifier of the collection.
LegacyResourceId	String	True		The legacy identifier of the collection in the REST Admin API.
Title	String	False		The display name of the collection, shown in the Shopify Admin and in sales channels such as the online store.
Handle	String	False		A unique, human-readable string that identifies the collection. If not specified at creation, the handle is automatically generated from the collection title using hyphens between words. For example, a collection titled 'Summer Catalog 2022' might generate the handle 'summer-catalog-2022'. The handle does not automatically change if the title changes. In themes, the handle can be referenced with Liquid, though the collection Id is preferred because it never changes.
DescriptionHtml	String	False		The description of the collection, including HTML formatting. This content is typically shown to customers in sales channels, depending on the theme.
ProductsCount	Int	True		The number of products included in the collection.
ProductsCountPrecision	String	True		The level of precision applied to the product count value.
SortOrder	String	False		The default order in which products in the collection are displayed in the Shopify Admin and in sales channels such as the online store. The allowed values are ALPHA_ASC, ALPHA_DESC, BEST_SELLING, CREATED, CREATED_DESC, MANUAL, PRICE_ASC, PRICE_DESC.
TemplateSuffix	String	False		The suffix of the Liquid template used to render the collection in an online store. For example, if the value is 'custom', the 'collection.custom.liquid' template is used. If null, the default 'collection.liquid' template is used.
AvailablePublicationsCount	Int	True		The number of publications where the collection is published without feedback errors.
AvailablePublicationsCountPrecision	String	True		The level of precision applied to the available publications count.
PublishedOnCurrentPublication	Bool	True		Indicates whether the collection is published to the calling app's publication.
UpdatedAt	Datetime	True		The date and time when the collection was last updated.
FeedbackSummary	String	True		A summary of feedback associated with the collection.
ImageId	String	True		The unique identifier of the image associated with the collection.
ImageWidth	Int	True		The original width of the collection image in pixels. Returns null if the image is not hosted by Shopify.
ImageAltText	String	False		Alternative text describing the content or purpose of the collection image.
ImageHeight	Int	True		The original height of the collection image in pixels. Returns null if the image is not hosted by Shopify.
ImageUrl	String	False		The URL of the collection image.
RuleSetRules	String	False		The rules used to assign products to the collection.
RuleSetAppliedDisjunctively	Bool	False		Specifies whether products must match any or all rules to be included in the collection. If true, products must match at least one rule. If false, products must match all rules.
SeoTitle	String	False		The search engine optimization (SEO) title of the collection, used in search engine results.
SeoDescription	String	False		The SEO description of the collection, used in search engine results.
Namespace	String	True		The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
Key	String	True		The key for the metafield.
Value	String	True		The value of the metafield.

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
ProductIds	String	Initial list of collection products. Only valid when creating a collection and without rules.
Metafields	String	The metafields to associate with the collection.
RedirectNewHandle	Bool	Whether a redirect is required after a new handle has been provided. If true, then the old handle is redirected to the new one automatically.

ADO.NET Provider for Shopify

Collections

Table-Specific Information

Select

Insert

CollectionRules Temporary Table Columns

Metafields Temporary Table Columns

Update

CollectionRules Temporary Table Columns

Delete

Columns

Pseudo-Columns