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

createRegionsWorkflow - Medusa Core Workflows Reference

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 Code

Examples#

Steps#

createRegionsStep

setRegionsPaymentProvidersStep

createPricePreferencesWorkflow

emitEventStep

Workflow Hook

Step conditioned by when

Input#

CreateRegionsWorkflowInputCreateRegionsWorkflowInput
regionsCreateRegionDTO & object[]
The regions to create.

Output#

CreateRegionsWorkflowOutputCreateRegionsWorkflowOutput
idstring
The ID of the region.
namestring
The name of the region.
currency_codestring
The currency code of the region.
automatic_taxesboolean
Setting to indicate whether taxes need to be applied automatically
countriesRegionCountryDTO[]
The countries of the region.
payment_providersPaymentProviderDTO[]
Payment providers available in the region
created_atstring
The date the region was created.
updated_atstring
The date the region was updated.
metadataRecord<string, any>Optional
Holds custom data in key-value pairs.
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
⇧↵