Menu

updateRegionsStep - Medusa Core Workflows Reference

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

This step updates regions matching the specified filters.

Example#

Code
1const data = updateRegionsStep({2  selector: {3    id: "reg_123"4  },5  update: {6    name: "United States"7  }8})

Input#

UpdateRegionsStepInputUpdateRegionsStepInput
The data to update regions.
selectorFilterableRegionProps
The filters to select the regions to update.
updateUpdateRegionDTO
The data to update in the regions.

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
⇧↵