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",
  "mail_from_address": "no-reply@example.com",
  "customer_support_email": "support@example.com",
  "new_order_notifications_email": "store-owner@example.com",
  "preferred_send_consumer_transactional_emails": true,
  "preferred_admin_locale": null,
  "preferred_timezone": "UTC",
  "preferred_weight_unit": "lb",
  "preferred_unit_system": "imperial",
  "created_at": "2026-06-24T14:17:10.902Z",
  "updated_at": "2026-06-24T14:18:46.969Z",
  "url": "http://www.example.com:3000",
  "supported_currencies": [
    "USD"
  ],
  "supported_locales": [
    "en"
  ],
  "available_locales": [
    "aa",
    "ab",
    "ae",
    "af",
    "ak",
    "am",
    "an",
    "ar",
    "as",
    "av",
    "ay",
    "az",
    "ba",
    "be",
    "bg",
    "bh",
    "bi",
    "bm",
    "bn",
    "bo",
    "br",
    "bs",
    "ca",
    "ce",
    "ch",
    "co",
    "cr",
    "cs",
    "cu",
    "cv",
    "cy",
    "da",
    "de",
    "de-AT",
    "de-CH",
    "dv",
    "dz",
    "ee",
    "el",
    "en",
    "en-AU",
    "en-CA",
    "en-GB",
    "en-IN",
    "en-NZ",
    "eo",
    "es",
    "es-419",
    "es-MX",
    "et",
    "eu",
    "fa",
    "ff",
    "fi",
    "fj",
    "fo",
    "fr",
    "fr-CA",
    "fy",
    "ga",
    "gd",
    "gl",
    "gn",
    "gu",
    "gv",
    "ha",
    "he",
    "hi",
    "ho",
    "hr",
    "ht",
    "hu",
    "hy",
    "hz",
    "ia",
    "id",
    "ie",
    "ig",
    "ii",
    "ik",
    "io",
    "is",
    "it",
    "iu",
    "ja",
    "jv",
    "ka",
    "kg",
    "ki",
    "kj",
    "kk",
    "kl",
    "km",
    "kn",
    "ko",
    "kr",
    "ks",
    "ku",
    "kv",
    "kw",
    "ky",
    "la",
    "lb",
    "lg",
    "li",
    "ln",
    "lo",
    "lt",
    "lu",
    "lv",
    "mg",
    "mh",
    "mi",
    "mk",
    "ml",
    "mn",
    "mr",
    "ms",
    "mt",
    "my",
    "na",
    "nb",
    "nd",
    "ne",
    "ng",
    "nl",
    "nn",
    "no",
    "nr",
    "nv",
    "ny",
    "oc",
    "oj",
    "om",
    "or",
    "os",
    "pa",
    "pi",
    "pl",
    "ps",
    "pt",
    "pt-BR",
    "pt-PT",
    "qu",
    "rm",
    "rn",
    "ro",
    "ru",
    "rw",
    "sa",
    "sc",
    "sd",
    "se",
    "sg",
    "si",
    "sk",
    "sl",
    "sm",
    "sn",
    "so",
    "sq",
    "sr",
    "ss",
    "st",
    "su",
    "sv",
    "sw",
    "ta",
    "te",
    "tg",
    "th",
    "ti",
    "tk",
    "tl",
    "tn",
    "to",
    "tr",
    "ts",
    "tt",
    "tw",
    "ty",
    "ug",
    "uk",
    "ur",
    "uz",
    "ve",
    "vi",
    "vo",
    "wa",
    "wo",
    "xh",
    "yi",
    "yo",
    "za",
    "zh-CN",
    "zh-HK",
    "zh-TW",
    "zu"
  ],
  "logo_url": null,
  "mailer_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
​
mail_from_address
string | null
required
​
customer_support_email
string | null
required
​
new_order_notifications_email
string | null
required
​
preferred_send_consumer_transactional_emails
boolean
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
​
available_locales
string[]
required
​
logo_url
string | null
required
​
mailer_logo_url
string | null
required