Collections
- Liliia Ostrovska
List of the shop’s collections. Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them.
Field | Description |
---|
Field | Description |
---|---|
Description | The stripped description of the collection, in a single line with HTML tags removed. |
Description HTML | The description of the collection, complete with HTML formatting. |
Handle | A unique human-friendly string for the collection. Automatically generated from the collection's title. |
ID | Globally unique ID. |
Products count | The number of products included in the collection. |
Products count precision | Precision of products count, how exact is the value. |
Sort order | The order in which the collection's products are sorted. |
Storefront ID | The storefront ID of the collection. |
Template suffix | The theme template used when viewing this collection in a store. |
Title | The title of the collection. |
Updated at | The date and time when the collection was last modified. |
The image associated with the collection.
Field | Description |
---|
Field | Description |
---|---|
Alt text | A word or phrase to share the nature or contents of an image. |
ID | Globally unique ID. |
Original src | The location of the original image as a URL. |
Transformed src | The location of the transformed image as a URL. |
A list of metafields that belong to the resource.
Field | Description |
---|
Field | Description |
---|---|
Description | The description of a metafield. |
Key | The key name for a metafield. |
Legacy resource ID | The ID of the corresponding resource in the REST Admin API. |
Metafield ID | Globally unique ID. |
Namespace | The namespace for a metafield. |
Owner type | Owner type of a metafield visible to the Storefront API. |
Type | The type of data that the metafield stores in the value field. |
Value | The value of a metafield. |
A list of metafields that belong to the resource.
Field | Description |
---|
Field | Description |
---|---|
Product ID | Globally unique ID. |
The set of rules that are used to determine which products are included in the collection. This applies only to smart collections.
Field | Description |
---|
Field | Description |
---|---|
Applied disjunctively | Whether products must match any or all of the rules to be included in the collection. If true, then products must match one or more 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. |