- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
Menu
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
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 CodeExamples#
src/api/workflow/route.ts1import 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#
DeleteStoresWorkflowInput
DeleteStoresWorkflowInputThe data to delete stores.
DeleteStoresWorkflowInput
DeleteStoresWorkflowInputids
string[]The IDs of the stores to delete.
ids
string[]Was this page helpful?