Menu

createRegionsStep - Medusa Core Workflows Reference

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

This step creates one or more regions.

Example#

Code
1const data = createRegionsStep([2  {3    currency_code: "usd",4    name: "United States",5    countries: ["us"],6  }7])

Input#

CreateRegionDTO[]CreateRegionDTO[]
namestring
The name of the region.
currency_codestring
The currency code of the region.
automatic_taxesbooleanOptional
Setting to indicate whether taxes need to be applied automatically
countriesstring[]Optional
The region's countries.
payment_providersstring[]Optional
The region's payment providers.
metadataMetadataTypeOptional
Holds custom data in key-value pairs.

Output#

RegionDTO[]RegionDTO[]
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
⇧↵