Skip to main content
POST
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
required
Example:

"Brooklyn warehouse"

​
external_references
object

Identities the record has in external systems, keyed by system: the same { system: external_id } map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of { system, external_id } entries is accepted too.

​
admin_name
string | null

Internal name shown only in the admin.

​
active
boolean
​
default
boolean

Setting to true demotes the previous default.

​
kind

Categorizes the location. The values listed are the built-in ones; extensions may add more.

Available options:
warehouse,
store,
fulfillment_center
Example:

"warehouse"

​
propagate_all_variants
boolean
​
backorderable_default
boolean
​
address1
string | null
​
address2
string | null
​
city
string | null
​
zipcode
string | null
​
phone
string | null
​
company
string | null
​
country_code
enum<string> | null

ISO-3166 alpha-2 country code.

Available options:
AD,
AE,
AF,
AG,
AI,
AL,
AM,
AO,
AR,
AS,
AT,
AU,
AW,
AZ,
BA,
BB,
BD,
BE,
BF,
BG,
BH,
BI,
BJ,
BL,
BM,
BN,
BO,
BQ,
BR,
BS,
BT,
BW,
BY,
BZ,
CA,
CC,
CD,
CF,
CG,
CH,
CI,
CK,
CL,
CM,
CN,
CO,
CR,
CU,
CV,
CW,
CX,
CY,
CZ,
DE,
DJ,
DK,
DM,
DO,
DZ,
EC,
EE,
EG,
ER,
ES,
ET,
FI,
FJ,
FK,
FM,
FO,
FR,
GA,
GB,
GD,
GE,
GF,
GG,
GH,
GI,
GL,
GM,
GN,
GP,
GQ,
GR,
GT,
GU,
GW,
GY,
HK,
HN,
HR,
HT,
HU,
ID,
IE,
IL,
IM,
IN,
IQ,
IR,
IS,
IT,
JE,
JM,
JO,
JP,
KE,
KG,
KH,
KI,
KM,
KN,
KP,
KR,
KW,
KY,
KZ,
LA,
LB,
LC,
LI,
LK,
LR,
LS,
LT,
LU,
LV,
LY,
MA,
MC,
MD,
ME,
MF,
MG,
MH,
MK,
ML,
MM,
MN,
MO,
MP,
MQ,
MR,
MS,
MT,
MU,
MV,
MW,
MX,
MY,
MZ,
NA,
NC,
NE,
NF,
NG,
NI,
NL,
NO,
NP,
NR,
NU,
NZ,
OM,
PA,
PE,
PF,
PG,
PH,
PK,
PL,
PM,
PN,
PR,
PS,
PT,
PW,
PY,
QA,
RE,
RO,
RS,
RU,
RW,
SA,
SB,
SC,
SD,
SE,
SG,
SH,
SI,
SJ,
SK,
SL,
SM,
SN,
SO,
SR,
SS,
ST,
SV,
SX,
SY,
SZ,
TC,
TD,
TG,
TH,
TJ,
TK,
TL,
TM,
TN,
TO,
TR,
TT,
TV,
TW,
TZ,
UA,
UG,
US,
UY,
UZ,
VA,
VC,
VE,
VG,
VI,
VN,
VU,
WF,
WS,
YE,
YT,
ZA,
ZM,
ZW
Example:

"US"

​
state_code
string | null

State or province abbreviation, resolved against the selected country's states.

Example:

"NY"

​
state_name
string | null

Free-text state for countries that don't have a states list.

​
pickup_enabled
boolean
​
pickup_stock_policy
enum<string>

local collects only items at this location; any lets items transfer in from other locations (ship-to-store).

Available options:
local,
any
​
pickup_ready_in_minutes
integer | null
​
returns_enabled
boolean

Whether customers may send returns to this location.

​
pickup_instructions
string | null

Response

stock location created

​
id
string
required
​
name
string
required
​
address1
string | null
required
​
city
string | null
required
​
zipcode
string | null
required
​
country_code
enum<string> | null
required
Available options:
AD,
AE,
AF,
AG,
AI,
AL,
AM,
AO,
AR,
AS,
AT,
AU,
AW,
AZ,
BA,
BB,
BD,
BE,
BF,
BG,
BH,
BI,
BJ,
BL,
BM,
BN,
BO,
BQ,
BR,
BS,
BT,
BW,
BY,
BZ,
CA,
CC,
CD,
CF,
CG,
CH,
CI,
CK,
CL,
CM,
CN,
CO,
CR,
CU,
CV,
CW,
CX,
CY,
CZ,
DE,
DJ,
DK,
DM,
DO,
DZ,
EC,
EE,
EG,
ER,
ES,
ET,
FI,
FJ,
FK,
FM,
FO,
FR,
GA,
GB,
GD,
GE,
GF,
GG,
GH,
GI,
GL,
GM,
GN,
GP,
GQ,
GR,
GT,
GU,
GW,
GY,
HK,
HN,
HR,
HT,
HU,
ID,
IE,
IL,
IM,
IN,
IQ,
IR,
IS,
IT,
JE,
JM,
JO,
JP,
KE,
KG,
KH,
KI,
KM,
KN,
KP,
KR,
KW,
KY,
KZ,
LA,
LB,
LC,
LI,
LK,
LR,
LS,
LT,
LU,
LV,
LY,
MA,
MC,
MD,
ME,
MF,
MG,
MH,
MK,
ML,
MM,
MN,
MO,
MP,
MQ,
MR,
MS,
MT,
MU,
MV,
MW,
MX,
MY,
MZ,
NA,
NC,
NE,
NF,
NG,
NI,
NL,
NO,
NP,
NR,
NU,
NZ,
OM,
PA,
PE,
PF,
PG,
PH,
PK,
PL,
PM,
PN,
PR,
PS,
PT,
PW,
PY,
QA,
RE,
RO,
RS,
RU,
RW,
SA,
SB,
SC,
SD,
SE,
SG,
SH,
SI,
SJ,
SK,
SL,
SM,
SN,
SO,
SR,
SS,
ST,
SV,
SX,
SY,
SZ,
TC,
TD,
TG,
TH,
TJ,
TK,
TL,
TM,
TN,
TO,
TR,
TT,
TV,
TW,
TZ,
UA,
UG,
US,
UY,
UZ,
VA,
VC,
VE,
VG,
VI,
VN,
VU,
WF,
WS,
YE,
YT,
ZA,
ZM,
ZW
​
country_name
string | null
required
​
state_code
string | null
required
​
state_text
string | null
required
​
pickup_ready_in_minutes
number | null
required
​
pickup_instructions
string | null
required
​
external_references
object
required
​
admin_name
string | null
required
​
address2
string | null
required
​
state_name
string | null
required
​
phone
string | null
required
​
company
string | null
required
​
active
boolean
required
​
default
boolean
required
​
backorderable_default
boolean
required
​
propagate_all_variants
boolean
required
​
kind
required

The values listed are the built-in ones; extensions may add more.

Available options:
warehouse,
store,
fulfillment_center
​
pickup_enabled
boolean
required
​
pickup_stock_policy
enum<string>
required
Available options:
local,
any
​
returns_enabled
boolean
required
​
created_at
string
required
​
updated_at
string
required
​
seller_id
string | null
required
​
seller_name
string | null
required
​
seller
object