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 CodeExamples#
Steps#
Workflow hook
Step conditioned by when
View step details
Input#
DeleteSalesChannelsWorkflowInput
DeleteSalesChannelsWorkflowInputThe data to delete sales channels.
DeleteSalesChannelsWorkflowInput
DeleteSalesChannelsWorkflowInputids
string[]The IDs of the sales channels to delete.
ids
string[]Emitted Events#
This section lists the events that are either triggered by the emitEventStep
in the workflow, or by another workflow executed within this workflow.
You can listen to these events in a subscriber, as explained in the Subscribers documentation.
Event | Description | Payload | Action |
---|---|---|---|
| Emitted when sales channels are deleted. |
|