Medusa
Store APIAdmin API
Store APIAdmin API
Discord
Twitter
Linkedin
Github
  1. Regions
  • Introduction
  • Authentication
  • HTTP Compression
  • Publishable API Key
  • Expanding Fields
  • Selecting Fields
  • Query Parameter Types
  • Pagination
  • Currencies
    • List Currencies
      GET
    • Get a Currency
      GET
  • Payment Providers
    • List Payment Providers
      GET
  • Return Reasons
    • List Return Reasons
      GET
    • Get a Return Reason
      GET
  • Auth
    • Retrieve Registration JWT Token
      POST
    • Authenticate Customer
      POST
    • Generate Reset Password Token for Customer
      POST
    • Refresh Authentication Token
      POST
    • Validate Authentication Callback
      POST
    • Delete Authentication Session
      DELETE
    • Set Authentication Session
      POST
    • Reset a Customer's Password
      POST
  • Collections
    • List Collections
      GET
    • Get a Collection
      GET
  • Regions
    • List Regions
      GET
    • Get a Region
      GET
  • Products
    • List Products
    • Get a Product
  • Customers
    • Get Logged-in Customer
    • Update Customer
    • Create Address for Logged-In Customer
    • List Customer's Addresses
    • Get Customer's Address
    • Update Customer's Address
    • Remove Customer's Address
    • Register Customer
  • Product Tags
    • List Product Tags
    • Get a Product Tag
  • Returns
    • Create Return
  • Product Types
    • Get a Product Type
    • List Product Types
  • Product Categories
    • List Product Categories
    • Get a Product Category
  • Carts
    • Create Cart
    • Set Cart's Customer
    • Add Shipping Method to Cart
    • Add Line Item to Cart
    • Calculate Cart Taxes
    • Get a Cart
    • Update a Cart
    • Update a Line Item in a Cart
    • Remove Line Item from Cart
    • Complete Cart
    • Add Promotions to Cart
    • Remove Promotions from Cart
  • Orders
    • List Logged-in Customer's Orders
    • Request Order Transfer
    • Get an Order
    • Cancel Order Transfer
    • Decline Order Transfer
    • Accept Order Transfer
  • Payment Collections
    • Initialize Payment Session of a Payment Collection
    • Create Payment Collection
  • Shipping Options
    • Calculate Shipping Option Price
    • List Shipping Options for Cart
  1. Regions

Get a Region

GET
/store/regions/{id}
Regions
Retrieve a region by its ID. You can expand the region's relations or select the fields that should be returned.
Request Request Example
JavaScript
Shell
Java
Swift
curl --location -g --request GET '{{BASE_URL}}/store/regions/' \
--header 'x-publishable-api-key;'
Response Response Example
200 - Example 1
{
    "region": {
        "id": "string",
        "name": "string",
        "currency_code": "usd",
        "automatic_taxes": true,
        "metadata": {},
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "countries": [
            {
                "id": "string",
                "iso_2": "us",
                "iso_3": "usa",
                "num_code": 840,
                "name": "string",
                "display_name": "string"
            }
        ],
        "payment_providers": [
            {
                "id": "string",
                "is_enabled": true
            }
        ]
    }
}

Request

Path Params
id
string 
required
The region's ID.
Query Params
fields
string 
fields
optional
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.
Header Params
x-publishable-api-key
string 
required
Publishable API Key created in the Medusa Admin.

Responses

🟢200OK
application/json
OK
Body
The region's details.
region
object (StoreRegion) 
required
The region's details.
id
string 
id
required
The region's ID.
name
string 
name
required
The region's name.
currency_code
string 
currency_code
required
The region's currency code.
Example:
usd
automatic_taxes
boolean 
automatic_taxes
optional
Whether taxes are calculated automatically during checkout for carts that belong to this region.
metadata
object 
optional
The region's metadata, can hold custom key-value pairs.
created_at
string <date-time>
created_at
optional
The date the region was created.
updated_at
string <date-time>
updated_at
optional
The date the region was updated.
countries
array[object (BaseRegionCountry) {6}] 
optional
The region's countries.
payment_providers
array[object (AdminPaymentProvider) {2}] 
optional
The region's payment providers.
🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
🟠409409
🟠422Parameter Error
🔴500Server Error
Modified at 2025-06-17 04:21:30
Previous
List Regions
Next
List Products
Built with