This documentation provides a reference to the createCollectionsWorkflow
. It belongs to the @medusajs/medusa/core-flows
package.
This workflow creates 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 created collections. For example, you can pass under additional_data
custom data that
allows you to create 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 creation.
Source CodeWorkflow hook
Step conditioned by when
View step details
CreateCollectionsWorkflowInput
CreateCollectionsWorkflowInputcollections
CreateProductCollectionDTO[]additional_data
Record<string, unknown>Optionaladditional_data
property in HTTP requests.
Learn more in this documentation.ProductCollectionDTO[]
ProductCollectionDTO[]id
stringtitle
stringhandle
stringcreated_at
string | Dateupdated_at
string | Datedeleted_at
string | DateOptionalHooks 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.
This hook is executed after the collections are created. You can consume this hook to perform custom actions on the created collections.
Handlers consuming this hook accept the following input.
input
inputcollections
ProductCollectionDTO[]additional_data
Record<string, unknown> | undefinedadditional_data
property in HTTP requests.
Learn more in this documentation.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.
Event | Description | Payload | Action |
---|---|---|---|
| Emitted when product collections are created. |
|