List countries
Returns countries available in the store. Use ?expand=market to include market details (currency, locale, tax_inclusive).
GET
Spree SDK
Documentation Index
Fetch the complete documentation index at: /docs/llms.txt
Use this file to discover all available pages before exploring further.
Returns countries available in the store. Use ?expand=market to include market details (currency, locale, tax_inclusive).
import { createClient } from '@spree/sdk'
const client = createClient({
baseUrl: 'https://your-store.com',
publishableKey: '<api-key>',
})
const countries = await client.countries.list()curl --request GET \
--url http://{defaultHost}/api/v3/store/countries \
--header 'x-spree-api-key: <api-key>'{
"data": [
{
"iso": "DE",
"iso3": "IS42",
"name": "Germany",
"states_required": false,
"zipcode_required": true
},
{
"iso": "US",
"iso3": "USA",
"name": "United States of America",
"states_required": true,
"zipcode_required": true
}
]
}{
"error": {
"code": "invalid_token",
"message": "Valid API key required"
}
}Publishable API key for store access
Comma-separated list of fields to include (e.g., name,slug,price). id is always included.
countries found
Show child attributes
Was this page helpful?
import { createClient } from '@spree/sdk'
const client = createClient({
baseUrl: 'https://your-store.com',
publishableKey: '<api-key>',
})
const countries = await client.countries.list()curl --request GET \
--url http://{defaultHost}/api/v3/store/countries \
--header 'x-spree-api-key: <api-key>'{
"data": [
{
"iso": "DE",
"iso3": "IS42",
"name": "Germany",
"states_required": false,
"zipcode_required": true
},
{
"iso": "US",
"iso3": "USA",
"name": "United States of America",
"states_required": true,
"zipcode_required": true
}
]
}{
"error": {
"code": "invalid_token",
"message": "Valid API key required"
}
}