updateCollectionsWorkflow - Medusa Core Workflows Reference

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

This workflow updates one or more collections. It's used by the Create Collection Admin API Route.

This workflow has a hook that allows you to perform custom actions on the updated collections. For example, you can pass under additional_data custom data that allows you to update custom data models linked to the product collections.

You can also use this workflow within your own custom workflows, allowing you to wrap custom logic around product-collection update.

Examples#

Steps#

Input#

Output#

Hooks#

Hooks allow you to inject custom functionalities into the workflow. You'll receive data from the workflow, as well as additional data sent through an HTTP request.

Learn more about Hooks and Additional Data.

collectionsUpdated#

This hook is executed after the collections are updated. You can consume this hook to perform custom actions on the updated collections.

Example

Code
1import { updateCollectionsWorkflow } from "@medusajs/medusa/core-flows"2
3updateCollectionsWorkflow.hooks.collectionsUpdated(4  (async ({ additional_data, collections }, { container }) => {5    //TODO6  })7)

Input

Handlers consuming this hook accept the following input.

Emitted Events#

This section lists the events that are either triggered by the emitEventStep in the workflow, or by another workflow executed within this workflow.

You can listen to these events in a subscriber, as explained in the Subscribers documentation.

[{
  id, // The ID of the product collection
}]