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

deleteSalesChannelsWorkflow - Medusa Core Workflows Reference

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

This workflow deletes one or more sales channels. It's used by the Delete Sales Channel Admin API Route.

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

Source Code

Examples#

Steps#

canDeleteSalesChannelsOrThrowStep

deleteSalesChannelsStep

removeRemoteLinkStep

emitEventStep

Workflow Hook

Step conditioned by when

Input#

DeleteSalesChannelsWorkflowInputDeleteSalesChannelsWorkflowInput
The data to delete sales channels.
idsstring[]
The IDs of the sales channels 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
⇧↵