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

let MEDUSA_BACKEND_URL = "http://localhost:9000"

if (process.env.NEXT_PUBLIC_MEDUSA_BACKEND_URL) {
  MEDUSA_BACKEND_URL = process.env.NEXT_PUBLIC_MEDUSA_BACKEND_URL
}

export const sdk = new Medusa({
  baseUrl: MEDUSA_BACKEND_URL,
  debug: process.env.NODE_ENV === "development",
  publishableKey: process.env.NEXT_PUBLIC_MEDUSA_PUBLISHABLE_KEY,
})

sdk.store.region.retrieve("reg_123")
.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"
  }
}

Headers

​
x-publishable-api-key
string
required

Publishable API Key created in the Medusa Admin.

​
x-medusa-locale
string

The locale in BCP 47 format to retrieve localized content.

Example:

"en-US"

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.

​
locale
string

The locale in BCP 47 format to retrieve localized content.

Example:

"en-US"

Response

OK

The region's details.

​
region
object
required

The region's details.