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.

NoteBy 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#

src/api/workflow/route.ts
1import type {2  MedusaRequest,3  MedusaResponse,4} from "@medusajs/framework/http"5import { deleteStoresWorkflow } from "@medusajs/medusa/core-flows"6
7export async function POST(8  req: MedusaRequest,9  res: MedusaResponse10) {11  const { result } = await deleteStoresWorkflow(req.scope)12    .run({13      input: {14        ids: ["store_123"]15      }16    })17
18  res.send(result)19}

Steps#

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?
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