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.

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.

productsCreated#

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

Example

Code
1import { createProductsWorkflow } from "@medusajs/medusa/core-flows"2
3createProductsWorkflow.hooks.productsCreated(4  (async ({ products, additional_data }, { 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 variant
}]

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