deleteStoresWorkflow - Medusa Core Workflows Reference

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

This workflow deletes one or more stores.

Note: By default, Medusa uses a single store. This is useful if you're building a multi-tenant application or a marketplace where each tenant has its own store. If you delete the only store in your application, the Medusa application will re-create it on application start-up.

You can use this workflow within your customizations or your own custom workflows, allowing you to delete stores within your custom flows.

Source Code

Examples#

Steps#

deleteStoresStep

Workflow Hook

Step conditioned by when

Input#

DeleteStoresWorkflowInputDeleteStoresWorkflowInput

The data to delete stores.

idsstring[]

The IDs of the stores to delete.

Was this page helpful?