Skip to main content
Anchor to CollectionUpdatePayload

CollectionUpdatePayload

payload

Return type for collectionUpdate mutation.

•Collection

The updated collection.

•Job

The asynchronous job updating the products based on the new rule set.

•[UserError!]!
non-null

The list of errors that occurred from executing the mutation.


Was this section helpful?

Anchor to Mutations with this payloadMutations with this payload

•mutation

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:

  • Updating collection details, like title, description, or image
  • Modifying SEO metadata for better search visibility
  • Changing which products are included in a collection by updating its rules, sources, or conditions
  • Updating custom data using metafields

Collections can include products manually and can also include products automatically based on rules, sources, or conditions. When product membership is updated through rules, sources, or conditions, the operation might be processed asynchronously. In these cases, the mutation returns a 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 collection conditions.

Arguments

•CollectionUpdateInput

The properties and sources to use when updating the collection.

•CollectionInput
Deprecated


Was this section helpful?