deleteRegionsWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the deleteRegionsWorkflow
. It belongs to the @medusajs/medusa/core-flows
package.
This workflow deletes one or more regions. It's used by the Delete Region Admin API Route.
You can use this workflow within your own customizations or custom workflows, allowing you to delete regions in your custom flows.
Source CodeExamples#
Steps#
Workflow hook
Step conditioned by when
View step details
Input#
DeleteRegionsWorkflowInput
DeleteRegionsWorkflowInput
DeleteRegionsWorkflowInput
DeleteRegionsWorkflowInputids
string[]
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 regions are deleted. |
|
Was this page helpful?