Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

batchProductsWorkflow - Medusa Core Workflows Reference

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

This workflow creates, updates, or deletes products. It's used by the Manage Products Admin API Route.

You can use this workflow within your own customizations or custom workflows to manage products in bulk. This is also useful when writing a seed script or a custom import script.

Source Code

Examples#

Steps#

createProductsWorkflow

updateProductsWorkflow

deleteProductsWorkflow

Workflow Hook

Step conditioned by when

Input#

BatchProductWorkflowInputBatchProductWorkflowInput
The products to manage.
createCreateProductWorkflowInputDTO[]Optional
Records to create in bulk.
updateUpdateProductWorkflowInputDTO[]Optional
Records to update in bulk.
deletestring[]Optional
Records to delete in bulk.

Output#

BatchWorkflowOutputBatchWorkflowOutput<ProductDTO>
ProductDTOProductDTO
A product's data.
Was this page helpful?
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break
⇧↵