Collection Update Payload
Return type for mutation.
Anchor to FieldsFields
- collection (Collection)
- job (Job)
- userErrors ([UserError!]!)
- Anchor to collectioncollection•Collection
The updated collection.
- •Job
The asynchronous job updating the products based on the new rule set.
- Anchor to userErrorsuser•[User
Errors Error!]! non-null The list of errors that occurred from executing the mutation.
Anchor to Mutations with this payloadMutations with this payload
- collectionUpdate (CollectionUpdatePayload)
- •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
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
jobobject that you can use to track the progress of the update.To publish or unpublish collections to specific sales channels, use the dedicated
andmutations.Learn more about using metafields with collection conditions.
- Anchor to collectioncollection•Collection
Update Input The properties and sources to use when updating the collection.
- Anchor to inputinput•Collection
Input Deprecated
Arguments