SmartCollections
Defines rule-based product collections that update automatically based on product conditions.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the smart collection. | |
| Title | String | False |
The display name of the smart collection, shown to customers. Maximum length: 255 characters. | |
| BodyHtml | String | False |
The description of the smart collection, formatted in HTML. This text commonly appears on the collection page in most shop themes. | |
| Image | String | False |
A JSON aggregate containing metadata for the smart collection's featured image, such as the image URL, dimensions, and alt text. | |
| Rules | String | False |
A JSON aggregate defining the set of rules that determine which products are automatically included in the smart collection. Valid rule fields include: column (tag, title, type, vendor, variant_price, variant_compare_at_price, variant_weight, variant_inventory, variant_title), relation (equals, greater_than, less_than, starts_with, ends_with, contains), and condition (a user-defined string). | |
| Handle | String | False |
A unique, human-readable string automatically generated from the collection title. Used in Liquid templates to reference the collection by its handle. Maximum length: 255 characters. | |
| Disjunctive | Bool | False |
Indicates whether products need to match any or all of the defined rules to be included. Valid values: true – a product must match one or more rules; false – a product must match all rules. | |
| SortOrder | String | False |
Specifies how products in the smart collection are sorted. Common values include 'alpha-asc', 'alpha-desc', 'best-selling', 'created', 'manual', 'price-asc', 'price-desc'. | |
| TemplateSuffix | String | False |
The suffix of the Liquid template used for rendering this collection. For example, if 'special' is set, Shopify uses 'collection.special.liquid' instead of the default 'collection.liquid'. | |
| PublishedScope | String | False |
Specifies where the collection is published. Valid values: web – published to online channels only; global – published to both online channels and the Point of Sale channel. | |
| UpdatedAt | Datetime | True |
The date and time when the smart collection was last modified. | |
| PublishedAt | Datetime | True |
The date and time when the smart collection was published. Returns null if the collection is hidden or unpublished. | |
| ProductId | String | True |
A filter parameter used to return only smart collections that include a specific product ID. | |
| PublishedStatus | String | True |
Filters smart collections by publication status. Valid values: published – only published collections; unpublished – only unpublished collections; any – all collections (default: any). The allowed values are published, unpublished, any. |