Menu

updateCollectionsStep - Medusa Core Workflows Reference

This documentation provides a reference to the updateCollectionsStep. It belongs to the @medusajs/medusa/core-flows package.

This step updates collections matching the specified filters.

Example#

Code
1const data = updateCollectionsStep({2  selector: {3    id: "collection_123"4  },5  update: {6    title: "Summer Collection"7  }8})

Input#

UpdateCollectionsStepInputUpdateCollectionsStepInput
The data to identify and update the product collections.
selectorFilterableProductCollectionProps
The filters to select the collections to update.
updateUpdateProductCollectionDTO
The data to update the collections with.

Output#

ProductCollectionDTO[]ProductCollectionDTO[]
idstring
The ID of the product collection.
titlestring
The title of the product collection.
handlestring
The handle of the product collection. The handle can be used to create slug URL paths.
created_atstring | Date
When the product collection was created.
updated_atstring | Date
When the product collection was updated.
metadataMetadataTypeOptional
Holds custom data in key-value pairs.
deleted_atstring | DateOptional
When the product collection was deleted.
productsProductDTO[]Optional
The associated products.
Was this page helpful?
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break
⇧↵