Medusa Core Workflows Reference

This section of the documentation provides a reference to the core workflows created by Medusa. Medusa uses these workflows in the Store and Admin API routes.

You can use these workflows and steps in your customizations. For example, you can execute these workflows:

• In an API route when a request is received;
• In a subscriber when an event is emitted;
• In a scheduled jobs at a specified interval during the application's runtime;
• In a custom CLI scripts that you can execute from the terminal;
• Or in a custom workflow that wraps the existing workflows and steps in a custom flow. You can then execute your custom workflow in the same way as the core workflows.

Through this reference, you'll learn about the available workflows and steps in Medusa out-of-the-box. For each workflow, you'll explore its steps, expected input and output, an example of executing that workflow, and how to inject custom functionalities into the workflow, if applicable.

All workflows and steps in this reference are exported by the @medusajs/medusa/core-flows package.

Edit this page