CustomCollections
Defines merchant-created product collections and supports creation, updates, and deletions.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the custom collection. | |
| Title | String | False |
The name of the custom collection as displayed in the store. | |
| BodyHtml | String | False |
The HTML-formatted description of the custom collection. | |
| Image | String | False |
A JSON object containing details about the custom collection's image, including source URL, dimensions, and creation data. | |
| Metafields | String | False |
Metadata associated with the collection, defined as a set of key-value pairs. Includes: key (up to 30 characters), namespace (up to 20 characters to distinguish metadata by app), value (the stored data), value_type (string or integer), and an optional description providing additional context. | |
| Handle | String | False |
A human-friendly unique string automatically generated from the collection's title and used in its URL. | |
| SortOrder | String | False |
The order in which products within the collection are arranged. | |
| TemplateSuffix | String | False |
The name of the alternate Liquid template used by the collection, if applicable. | |
| PublishedScope | String | False |
Specifies the sales channels where the collection is available. | |
| UpdatedAt | Datetime | True |
The date and time when the custom collection was last updated. | |
| PublishedAt | Datetime | True |
The date and time when the custom collection was published to the Online Store channel. | |
| ProductId | String | False |
Filters collections to include only those containing a specific product ID. | |
| PublishedStatus | String | False |
Indicates the collection's publication status. Valid values: published (visible), unpublished (hidden), or any (default, includes all). The allowed values are published, unpublished, any. |