List Regions

GET

/store/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

Header Params

Responses

🟢200OK

application/json

Body

🟠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