Skip to main content
GET
/
api
/
v3
/
admin
/
store
Spree Admin SDK
import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

const store = await client.store.get()
{
  "id": "store_UkLWZg9DAJ",
  "metadata": {},
  "name": "Spree Test Store",
  "default_currency": "USD",
  "default_locale": "en",
  "preferred_admin_locale": null,
  "preferred_timezone": "UTC",
  "preferred_weight_unit": "lb",
  "preferred_unit_system": "imperial",
  "created_at": "2026-06-01T13:00:31.956Z",
  "updated_at": "2026-06-01T13:02:02.798Z",
  "url": "http://www.example.com:3000",
  "supported_currencies": [
    "USD"
  ],
  "supported_locales": [
    "en"
  ],
  "logo_url": null
}

Authorizations

​
x-spree-api-key
string
header
required

Secret API key for admin access

​
Authorization
string
header
required

JWT token for admin user authentication

Headers

​
x-spree-api-key
string
required
​
Authorization
string
required

Bearer token for admin authentication

Response

current store

​
id
string
required
​
metadata
object
required
​
name
string
required
​
default_currency
string
required
​
default_locale
string
required
​
preferred_admin_locale
string | null
required
​
preferred_timezone
string
required
​
preferred_weight_unit
string
required
​
preferred_unit_system
string
required
​
created_at
string
required
​
updated_at
string
required
​
url
string
required
​
supported_currencies
string[]
required
​
supported_locales
string[]
required
​
logo_url
string | null
required