Skip to main content
POST
/
admin
/
regions
/
{id}
JS SDK
import Medusa from "@medusajs/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.region.update("region_123", {
  name: "United States",
})
.then(({ region }) => {
  console.log(region)
})
{
  "region": {
    "id": "<string>",
    "name": "<string>",
    "currency_code": "usd",
    "automatic_taxes": true,
    "countries": [
      {
        "id": "<string>",
        "iso_2": "us",
        "iso_3": "usa",
        "num_code": 840,
        "name": "<string>",
        "display_name": "<string>"
      }
    ],
    "payment_providers": [
      {
        "id": "<string>",
        "is_enabled": true
      }
    ],
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

The region's ID.

Query Parameters

​
fields
string

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

Body

application/json

The propeties to update in the region.

​
name
string

The region's name.

​
currency_code
string

The region's currency code.

​
countries
string[]

The region's countries.

A country code.

​
automatic_taxes
boolean

Whether taxes are calculated automatically for carts in the region.

​
payment_providers
string[]

The payment providers enabled in the region.

A payment provider's ID.

​
metadata
object

The region's metadata. Can hold custom key-value pairs.

​
is_tax_inclusive
boolean

Whether the prices in the region are tax inclusive.

Response

OK

The region's details.

​
region
object
required

The region's details.