List supported locales
Returns locales supported by the store (derived from markets)
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 locales supported by the store (derived from markets)
import { createClient } from '@spree/sdk'
const client = createClient({
baseUrl: 'https://your-store.com',
publishableKey: '<api-key>',
})
const locales = await client.locales.list()curl --request GET \
--url http://{defaultHost}/api/v3/store/locales \
--header 'x-spree-api-key: <api-key>'{
"data": [
{
"code": "de",
"name": "de",
"default": false,
"rtl": false
},
{
"code": "en",
"name": "English",
"default": true,
"rtl": false
}
]
}{
"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.
locales 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 locales = await client.locales.list()curl --request GET \
--url http://{defaultHost}/api/v3/store/locales \
--header 'x-spree-api-key: <api-key>'{
"data": [
{
"code": "de",
"name": "de",
"default": false,
"rtl": false
},
{
"code": "en",
"name": "English",
"default": true,
"rtl": false
}
]
}{
"error": {
"code": "invalid_token",
"message": "Valid API key required"
}
}