Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

 Collections

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

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.

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.

 Collections / Image

The image associated with the collection.

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.

 Collections / Metafields

A list of metafields that belong to the resource.

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.

 Collections / Products

A list of metafields that belong to the resource.

Field

Description

Product ID

Globally unique ID.

 Collections / Rule set

The set of rules that are used to determine which products are included in the collection. This applies only to smart collections.

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.

 Collections / Rule set / Rules

The rules used to assign products to the collection. This applies only to smart collections.

Field

Description

Column

The attribute that the rule focuses on (for example, title or product_type).

Condition

The value that the operator is applied to (for example, Hats).

Relation

The type of operator that the rule is based on (for example, equals, contains, or not_equals).

 Collections / SEO

SEO information for the collection.

Field

Description

Description

SEO Description.

Title

SEO Title.

  • No labels