Requires access scope.
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. For example, an athletics store might create different collections for running attire, shoes, and accessories.
Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections.
Collections can also be created for a custom group of products. These are called custom or manual collections.
Fields and connections
The number of publications that a resource is published to, without feedback errors.
A single-line, text-only description of the collection, stripped of any HTML tags and formatting that were included in the description.
The description of the collection, including any HTML tags and formatting. This content is typically displayed to customers, such as on an online store, depending on the theme.
The paginated list of events associated with the host subject.
Information about the collection that's provided through resource feedback.
A unique string that identifies the collection. If a handle isn't specified when a collection is created, it's automatically generated from the collection's original title, and typically includes words from the title separated by hyphens. For example, a collection that was created with the title
Summer Catalog 2022might have the handlesummer-catalog-2022.If the title is changed, the handle doesn't automatically change.
The handle can be used in themes by the Liquid templating language to refer to the collection, but using the ID is preferred because it never changes.
Whether the collection includes the specified product.
A globally-unique ID.
The image associated with the collection.
The ID of the corresponding resource in the REST Admin API.
A custom field, including its
namespaceandkey, that's associated with a Shopify resource for the purposes of adding and storing additional information.A list of custom fields that a merchant associates with a Shopify resource.
The products that are included in the collection.
The number of products in the collection.
Whether the resource is published to the app's publication. For example, the resource might be published to the app's online store channel.
Whether the resource is published to a specified publication.
The list of resources that are published to a publication.
The number of publications that a resource is published to, without feedback errors.
The list of resources that are either published or staged to be published to a publication.
For a smart (automated) collection, specifies the rules that determine whether a product is included.
If the default SEO fields for page title and description have been modified, contains the modified information.
The order in which the products in the collection are displayed by default in the Shopify admin and in sales channels, such as an online store.
The suffix of the Liquid template being used to show the collection in an online store. For example, if the value is
custom, then the collection is using thecollection.custom.liquidtemplate. If the value isnull, then the collection is using the defaultcollection.liquidtemplate.The name of the collection. It's displayed in the Shopify admin and is typically displayed in sales channels, such as an online store.
The published translations associated with the resource.
The list of publications that the resource isn't published to.
The date and time (ISO 8601 format) when the collection was last modified.
Returns a Collection resource by ID.
Return a collection by its handle.
Returns a list of collections.
Mutations
Adds products to a collection.
Creates a collection.
Updates a collection.