- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
createProductsWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the createProductsWorkflow
. It belongs to the @medusajs/medusa/core-flows
package.
This workflow creates one or more products. It's used by the Create Product Admin API Route. It can also be useful to you when creating seed scripts, for example.
This workflow has a hook that allows you to perform custom actions on the created products. You can see an example in this guide.
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around product creation.
Source CodeExamples#
Steps#
Workflow Hook
Step conditioned by when
Input#
CreateProductsWorkflowInput
CreateProductsWorkflowInputThe data to create one or more products, along with custom data that's passed to the workflow's hooks.
CreateProductsWorkflowInput
CreateProductsWorkflowInputproducts
CreateProductWorkflowInputDTO[]The products to create.
products
CreateProductWorkflowInputDTO[]additional_data
Record<string, unknown>OptionalAdditional data that can be passed through the additional_data
property in HTTP requests.
Learn more in this documentation.
additional_data
Record<string, unknown>Optionaladditional_data
property in HTTP requests.
Learn more in this documentation.Output#
ProductDTO[]
ProductDTO[]
ProductDTO[]
ProductDTO[]ProductDTO
ProductDTOA product's data.
ProductDTO
ProductDTOHooks#
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.
productsCreated#
This step is a hook that you can inject custom functionality into.
Example
Input
Handlers consuming this hook accept the following input.
input
objectThe input data for the hook.
input
objectproducts
ProductDTO[]
products
ProductDTO[]additional_data
Record<string, unknown> | undefinedAdditional data that can be passed through the additional\_data
property in HTTP requests.
Learn more in this documentation.
additional_data
Record<string, unknown> | undefinedadditional\_data
property in HTTP requests.
Learn more in this documentation.