createCollectionsWorkflow - Medusa Core Workflows Reference
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 CodeExamples#
Steps#
Workflow hook
Step conditioned by when
View step details
Input#
CreateCollectionsWorkflowInputCreateCollectionsWorkflowInputThe details of the collection to create, along with custom data that's passed to the workflow's hooks.
CreateCollectionsWorkflowInputCreateCollectionsWorkflowInputcollectionsCreateProductCollectionDTO[]The collections to create.
collectionsCreateProductCollectionDTO[]additional_dataRecord<string, unknown>OptionalAdditional data that can be passed through the additional_data property in HTTP requests.
Learn more in this documentation.
additional_dataRecord<string, unknown>Optionaladditional_data property in HTTP requests.
Learn more in this documentation.Output#
ProductCollectionDTO[]ProductCollectionDTO[]
ProductCollectionDTO[]ProductCollectionDTO[]idstringThe ID of the product collection.
idstringtitlestringThe title of the product collection.
titlestringhandlestringThe handle of the product collection. The handle can be used to create slug URL paths.
handlestringcreated_atstring | DateWhen the product collection was created.
created_atstring | Dateupdated_atstring | DateWhen the product collection was updated.
updated_atstring | DateHolds custom data in key-value pairs.
deleted_atstring | DateOptionalWhen the product collection was deleted.
deleted_atstring | DateOptionalThe associated products.
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.
collectionsCreated#
Handlers consuming this hook accept the following input.
inputobject
inputobjectcollectionsProductCollectionDTO[]
collectionsProductCollectionDTO[]additional_dataRecord<string, unknown> | undefinedAdditional data that can be passed through the additional_data property in HTTP requests.
Learn more in this documentation.
additional_dataRecord<string, unknown> | undefinedadditional_data property in HTTP requests.
Learn more in this documentation.