This documentation provides a reference to the createRegionsWorkflow
. It belongs to the @medusajs/medusa/core-flows
package.
This workflow creates one or more regions. It's used by the Create Region Admin API Route.
You can use this workflow within your own customizations or custom workflows, allowing you to create regions in your custom flows.
Source CodeWorkflow hook
Step conditioned by when
View step details
CreateRegionsWorkflowInput
CreateRegionsWorkflowInputregions
CreateRegionDTO & object[]CreateRegionsWorkflowOutput
CreateRegionsWorkflowOutputid
stringname
stringcurrency_code
stringautomatic_taxes
booleancountries
RegionCountryDTO[]payment_providers
PaymentProviderDTO[]created_at
stringupdated_at
stringmetadata
Record<string, any>OptionalThis 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 created. |
|