Skip to main content
PATCH
Spree Admin SDK

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
code
string
required
preferred_storefront_url
string | null
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
preferred_storefront_access
string
required
preferred_guest_checkout
boolean
required
preferred_order_routing_strategy
string
required
created_at
string
required
updated_at
string
required
url
string
required
api_url
string
required
setup_tasks
object[]
required
supported_currencies
string[]
required
supported_locales
string[]
required
available_locales
string[]
required
logo_url
string | null
required
mailer_logo_url
string | null
required