Requires read_products access scope.
The Collection object represents a group of products that merchants can organize to make their stores easier to browse and help customers find related products. Collections serve as the primary way to categorize and display products across online stores, sales channels, and marketing campaigns.
There are two types of collections:
The Collection object provides information to:
Collections are unpublished by default. To make them available to customers, use the publishablePublish mutation after creation.
Collections can be displayed in a store with Shopify's theme system through Liquid templates and can be customized with template suffixes for unique layouts. They also support advanced features like translated content, resource feedback, and contextual publication for location-based catalogs.
Learn about using metafields with smart collections.
A single-line, text-only description of the collection, stripped of any HTML tags and formatting that were included in the description.
Truncates a string after the given length.
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 2022 might have the handle summer-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.
The ID of the product to check.
The image associated with the collection.
The ID of the corresponding resource in the REST Admin API.
A custom field, including its namespace and key, 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 ID of the publication to check. For example, id: "gid://shopify/Publication/123".
The list of resources that are published to a publication.
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 the collection.custom.liquid template. If the value is null, then the collection is using the default collection.liquid template.
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.
Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.
The ID of the channel to check.
Retrieves a collection by its ID. A collection represents a grouping of products that merchants can display and sell as a group in their online store and other sales channels.
Use the collection query when you need to:
A collection can be either a custom (manual) collection where products are manually added, or a smart (automated) collection where products are automatically included based on defined rules. Each collection has associated metadata including title, description, handle, image, and metafields.
Return a collection by an identifier.
Retrieves a list of collections in a store. Collections are groups of products that merchants can organize for display in their online store and other sales channels. For example, an athletics store might create different collections for running attire, shoes, and accessories.
Use the collections query when you need to:
The collections query supports pagination for large catalogs and saved searches for frequently used collection queries.
The collections query returns collections with their associated metadata, including:
Learn more about using metafields with smart collections.
Adds products to a collection.
Creates a collection to group products together in the online store and other sales channels. For example, an athletics store might create different collections for running attire, shoes, and accessories.
There are two types of collections:
Use the collectionCreate mutation when you need to:
The created collection is unpublished by default. To make it available to customers, use the publishablePublish mutation after creation.
Learn more about using metafields with smart collections.
Updates a collection, modifying its properties, products, or publication settings. Collections help organize products together in the online store and other sales channels.
Use the collectionUpdate mutation to programmatically modify collections in scenarios such as:
There are two types of collections with different update capabilities:
job object that you can use to track the progress of the update.To publish or unpublish collections to specific sales channels, use the dedicated publishablePublish and publishableUnpublish mutations.
Learn more about using metafields with smart collections.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4