Collections
Returns manual and automated collections with titles, rules, 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.
- Title supports the '=, !=' comparison operators.
- Handle supports the '=, IN' comparison operators.
- UpdatedAt supports the '=, !=, <, >, >=, <=' comparison operators.
- Namespace supports the '=, IN' comparison operators.
- Key supports the '=, IN' comparison operators.
- Value supports the '=, IN' comparison operators.
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'
Update
The following column can be updated:
SortOrder
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The globally unique identifier of the collection. | |
| LegacyResourceId | String | True |
The legacy identifier of the collection in the REST Admin API. | |
| Title | String | True |
The display name of the collection, shown in the Shopify Admin and in sales channels such as the online store. | |
| Handle | String | True |
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 | True |
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. | |
| TemplateSuffix | String | True |
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 | True |
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 | True |
The URL of the collection image. | |
| RuleSetAppliedDisjunctively | Bool | True |
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 | True |
The search engine optimization (SEO) title of the collection, used in search engine results. | |
| SeoDescription | String | True |
The SEO description of the collection, used in search engine results. | |
| Namespace | String | True |
The container the metafield belongs to. If not specified, the app-reserved namespace will be used. | |
| Key | String | True |
The unique key that identifies the metafield within its namespace for the collection. | |
| Value | String | True |
The stored data of the metafield for the collection. |