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

exportProductsWorkflow - Medusa Core Workflows Reference

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

This workflow exports products matching the specified filters. It's used by the Export Products Admin API Route.

Note: This workflow doesn't return the exported products. Instead, it sends a notification to the admin users that they can download the exported products. Learn more in the API Reference.
Source Code

Examples#

To export all products:

To export products matching a criteria:

Steps#

getAllProductsStep

notifyOnFailureStep

generateProductCsvStep

useRemoteQueryStep

sendNotificationsStep

Workflow Hook

Step conditioned by when

Input#

ExportProductsDTOExportProductsDTO
selectstring[]
The fields to select. These fields will be passed to Query, so you can pass product properties or any relation names, including custom links.
filterFilterableProductPropsOptional
The filters to select which products to export.
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
⇧↵