Countries (address taxonomy)
GET/v1/geo/countries
scope catalog.read
Countries for building an address. By default only the ones we sell in; pass all=1 for every country we hold.
Query parameters#
| Name | Example | |
|---|---|---|
all | — | 1 to include countries we do not sell in |
Response#
| Field | Type | Description |
|---|---|---|
count | integer | How many countries. |
data | array | Countries with geo data, for building an address picker. GET /v1/countries is the shorter version of the same list. |
data[]. | integer | Our internal country id. The geo endpoints take this; the rest of the API takes code. |
data[]. | string | ISO-2. |
data[]. | string | Country name. |
data[]. | string | The currency listings there are priced in. |
data[]. | string | Dialling prefix, without the +. |
data[]. | boolean | Whether the platform currently operates there. |
Example
{
"count": 32,
"data": [
{
"id": 190,
"code": "RO",
"name": "Romania",
"currency": "RON",
"phone_prefix": "40",
"is_active": true
}
]
}