Skip to main content
GET
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

Response

current store

id
string
required
metadata
object
required
name
string
required
code
string
required
default_currency
enum<string>
required
Available options:
AED,
AFN,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BTN,
BWP,
BYN,
BYR,
BZD,
CAD,
CDF,
CHF,
CLF,
CLP,
CNY,
COP,
CRC,
CUC,
CUP,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EEK,
EGP,
ERN,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HRK,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
IRR,
ISK,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KPW,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LTL,
LVL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MRO,
MRU,
MTL,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SDG,
SEK,
SGD,
SHP,
SKK,
SLE,
SLL,
SOS,
SRD,
SSP,
STD,
STN,
SVC,
SYP,
SZL,
THB,
TJS,
TMM,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYI,
UYU,
UYW,
UZS,
VED,
VEF,
VES,
VND,
VUV,
WST,
XAF,
XCD,
XCG,
XOF,
XPF,
YER,
ZAR,
ZMK,
ZMW,
ZWD,
ZWG,
ZWL,
ZWN,
ZWR
default_locale
enum<string>
required
Available options:
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,
en-US,
eo,
es,
es-419,
es-CL,
es-EC,
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,
sl-SI,
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
default_country_code
string | null
required
mail_from_address
string | null
required
customer_support_email
string | null
required
new_order_notifications_email
string | null
required
created_at
string
required
updated_at
string
required
order_routing_strategy
string
required

Order routing strategy. Built-in: rules. Extensions may register more.

payout_provider
string | null
required

Payout provider; null uses the installation default. Built-in: system. Provider gems register more (e.g. stripe).

admin_locale
string | null
required
timezone
string
required
storefront_url
string | null
required
weight_unit
enum<string>
required
Available options:
g,
kg,
lb,
oz
unit_system
enum<string>
required
Available options:
metric,
imperial
storefront_access
enum<string>
required
Available options:
public,
prices_hidden,
login_required
guest_checkout
boolean
required
always_include_confirm_step
boolean
required
company_field_enabled
boolean
required
address_requires_company
boolean
required
address_requires_phone
boolean
required
capture_method
enum<string>
required
Available options:
checkout,
on_dispatch,
manual
track_inventory_levels
boolean
required
stock_reservations_enabled
boolean
required
low_stock_threshold
number
required
tax_using_ship_address
boolean
required
track_price_history
boolean
required
show_products_without_price
boolean
required
disable_sku_validation
boolean
required
pricing_provider
string
required
inventory_provider
string
required
pricing_provider_failure_policy
enum<string>
required
Available options:
fallback,
strict
inventory_provider_failure_policy
enum<string>
required
Available options:
fallback,
strict
default_payouts_schedule_interval
enum<string>
required
Available options:
daily,
weekly,
biweekly,
monthly,
manual
auto_approve_sellers
boolean
required
auto_approve_seller_products
boolean
required
send_seller_transactional_emails
boolean
required
document_number_format
enum<string>
required
Available options:
sequential,
random
order_number_prefix
string
required
order_number_suffix
string
required
order_number_sequence_start
number
required
limit_digital_download_count
boolean
required
digital_asset_authorized_clicks
number
required
limit_digital_download_days
boolean
required
digital_asset_authorized_days
number
required
send_consumer_transactional_emails
boolean
required
email_accent_color
string | null
required
email_background_color
string | null
required
email_card_color
string | null
required
email_text_color
string | null
required
email_heading_color
string | null
required
email_font
enum<string> | null
required
Available options:
inter,
system,
helvetica,
georgia,
roboto,
lato,
merriweather
order_number_sequence_started
boolean
required
default_minimum_payout_amount
string | null
required
default_commission_tax_rate
string | null
required
url
string
required
api_url
string
required
setup_tasks
object[]
required
supported_currencies
enum<string>[]
required
Available options:
AED,
AFN,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BTN,
BWP,
BYN,
BYR,
BZD,
CAD,
CDF,
CHF,
CLF,
CLP,
CNY,
COP,
CRC,
CUC,
CUP,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EEK,
EGP,
ERN,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HRK,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
IRR,
ISK,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KPW,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LTL,
LVL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MRO,
MRU,
MTL,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SDG,
SEK,
SGD,
SHP,
SKK,
SLE,
SLL,
SOS,
SRD,
SSP,
STD,
STN,
SVC,
SYP,
SZL,
THB,
TJS,
TMM,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYI,
UYU,
UYW,
UZS,
VED,
VEF,
VES,
VND,
VUV,
WST,
XAF,
XCD,
XCG,
XOF,
XPF,
YER,
ZAR,
ZMK,
ZMW,
ZWD,
ZWG,
ZWL,
ZWN,
ZWR
supported_locales
enum<string>[]
required
Available options:
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,
en-US,
eo,
es,
es-419,
es-CL,
es-EC,
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,
sl-SI,
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
available_locales
enum<string>[]
required
Available options:
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,
en-US,
eo,
es,
es-419,
es-CL,
es-EC,
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,
sl-SI,
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
string | null
required
mailer_logo_url
string | null
required