Skip to main content
PATCH
/
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.update({
  name: 'My Store'
})
{
  "id": "store_UkLWZg9DAJ",
  "metadata": {},
  "name": "Renamed 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-22T16:55:31.699Z",
  "updated_at": "2026-06-22T16:57:02.659Z",
  "url": "http://www.example.com:3000",
  "supported_currencies": [
    "USD"
  ],
  "supported_locales": [
    "en"
  ],
  "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

Body

application/json
name
string
Example:

"My Store"

preferred_admin_locale
string
Example:

"en"

preferred_timezone
string
Example:

"UTC"

preferred_weight_unit
string
Example:

"kg"

preferred_unit_system
string
Example:

"metric"

Response

store updated

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
logo_url
string | null
required
mailer_logo_url
string | null
required