List Regions

GET

/store/regions

Regions

Retrieve a list of regions. The regions can be filtered by fields such as id. The regions can also be sorted or paginated.

Request Example

JavaScript

Shell

Java

Swift

curl --location -g --request GET '{{BASE_URL}}/store/regions' \
--header 'x-publishable-api-key;'

Response Example

200 - Example 1

{
    "limit": 0,
    "offset": 0,
    "count": 0,
    "regions": [
        {
            "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

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.

offset

number

offset

optional

The number of items to skip when retrieving a list.

limit

number

limit

optional

Limit the number of items returned in the list.

order

string

order

optional

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

string

optional

Search term to filter the region's searchable properties.

optional

One of

array[string]

Filter by a region's ID.

name

optional

One of

name

array[string]

Filter by a region name.

currency_code

optional

One of

currency_code

array[string]

Filter by a currency code to retrieve regions that use that code.

$and

array [object]

$and

optional

Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

$or

array [object]

$or

optional

Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.

Header Params

x-publishable-api-key

string

required

Publishable API Key created in the Medusa Admin.

Responses

🟢200OK

application/json

Body

The paginated list of regions.

limit

number

limit

required

The maximum number of items returned.

offset

number

offset

required

The number of items skipped before retrieving the returned items.

count

number

count

required

The total number of items.

regions

array[object (StoreRegion) {9}]

required

The list of regions.

string

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

Get a Collection

Get a Region