Choose a version:

Collection

object

Requires read_products 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.

Anchor to Fields and connectionsFields and connections

Anchor to availablePublicationsCountavailablePublicationsCount •Count: The number of publications that a resource is published to, without feedback errors.
Anchor to descriptiondescription •String!non-null: A single-line, text-only description of the collection, stripped of any HTML tags and formatting that were included in the description.
Anchor to descriptionHtmldescriptionHtml •HTML!non-null: 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.
Anchor to eventsevents •EventConnection!non-null: The paginated list of events associated with the host subject.
Anchor to feedbackfeedback •ResourceFeedback: Information about the collection that's provided through resource feedback.
Anchor to handlehandle •String!non-null: 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.
Anchor to hasProducthasProduct •Boolean!non-null: Whether the collection includes the specified product.
Anchor to idid •ID!non-null: A globally-unique ID.
Anchor to imageimage •Image: The image associated with the collection.
Anchor to legacyResourceIdlegacyResourceId •UnsignedInt64!non-null: The ID of the corresponding resource in the REST Admin API.
Anchor to metafieldmetafield •Metafield: A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.
Anchor to metafieldsmetafields •MetafieldConnection!non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to productsproducts •ProductConnection!non-null: The products that are included in the collection.
Anchor to productsCountproductsCount •Count: The number of products in the collection.
Anchor to publishedOnCurrentPublicationpublishedOnCurrentPublication •Boolean!non-null: Whether the resource is published to the app's publication. For example, the resource might be published to the app's online store channel.
Anchor to publishedOnPublicationpublishedOnPublication •Boolean!non-null: Whether the resource is published to a specified publication.
Anchor to resourcePublicationsresourcePublications •ResourcePublicationConnection!non-null: The list of resources that are published to a publication.
Anchor to resourcePublicationsCountresourcePublicationsCount •Count: The number of publications that a resource is published to, without feedback errors.
Anchor to resourcePublicationsV2resourcePublicationsV2 •ResourcePublicationV2Connection!non-null: The list of resources that are either published or staged to be published to a publication.
Anchor to ruleSetruleSet •CollectionRuleSet: For a smart (automated) collection, specifies the rules that determine whether a product is included.
Anchor to seoseo •SEO!non-null: If the default SEO fields for page title and description have been modified, contains the modified information.
Anchor to sortOrdersortOrder •CollectionSortOrder!non-null: 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.
Anchor to templateSuffixtemplateSuffix •String: 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.
Anchor to titletitle •String!non-null: The name of the collection. It's displayed in the Shopify admin and is typically displayed in sales channels, such as an online store.
Anchor to translationstranslations •[Translation!]!non-null: The published translations associated with the resource.
Anchor to unpublishedPublicationsunpublishedPublications •PublicationConnection!non-null: The list of publications that the resource isn't published to.
Anchor to updatedAtupdatedAt •DateTime!non-null: The date and time (ISO 8601 format) when the collection was last modified.

Deprecated fields and connections

Anchor to metafieldDefinitionsmetafieldDefinitions •MetafieldDefinitionConnection!non-nullDeprecated
Anchor to privateMetafieldprivateMetafield •PrivateMetafieldDeprecated
Anchor to privateMetafieldsprivateMetafields •PrivateMetafieldConnection!non-nullDeprecated
Anchor to publicationCountpublicationCount •Int!non-nullDeprecated
Anchor to publicationspublications •CollectionPublicationConnection!non-nullDeprecated
Anchor to publishedOnChannelpublishedOnChannel •Boolean!non-nullDeprecated
Anchor to publishedOnCurrentChannelpublishedOnCurrentChannel •Boolean!non-nullDeprecated
Anchor to storefrontIdstorefrontId •StorefrontID!non-nullDeprecated
Anchor to unpublishedChannelsunpublishedChannels •ChannelConnection!non-nullDeprecated

Was this section helpful?

Anchor to QueriesQueries

Anchor to collection collection •query: Returns a Collection resource by ID.
Anchor to collections collections •query: Returns a list of collections.
Anchor to collectionByHandle collectionByHandle •queryDeprecated

Was this section helpful?

Anchor to MutationsMutations

collectionAddProducts

•mutation

Adds products to a collection.

Anchor to idid •ID!required: The ID of the collection that's being updated. This can't be a smart collection.
Anchor to productIdsproductIds •[ID!]!required: The IDs of the products that are being added to the collection. If any of the products is already present in the input collection, then an error is raised and no products are added.

Anchor to collectioncollection •Collection: The updated collection. Returns null if an error is raised.
Anchor to userErrorsuserErrors •[UserError!]!non-null: The list of errors that occurred from executing the mutation.

collectionCreate

•mutation

Creates a collection.

Anchor to inputinput •CollectionInput!required: The properties to use when creating the collection.

Anchor to collectioncollection •Collection: The collection that has been created.
Anchor to userErrorsuserErrors •[UserError!]!non-null: The list of errors that occurred from executing the mutation.

collectionUpdate

•mutation

Updates a collection.

Anchor to inputinput •CollectionInput!required: The updated properties for the collection.

Anchor to collectioncollection •Collection: The updated collection.
Anchor to jobjob •Job: The asynchronous job updating the products based on the new rule set.
Anchor to userErrorsuserErrors •[UserError!]!non-null: The list of errors that occurred from executing the mutation.