Skip to main content
PATCH
Spree Seller SDK

Authorizations

Authorization
string
header
required

JWT token for an authenticated seller session (seller_api audience)

Headers

X-Spree-Seller-Id
string
required

Body

application/json
name
string
Example:

"Acme Supplies"

contact_email
string<email> | null
billing_email
string<email> | null
about
string | null

Sanitized HTML: the seller's public description.

The business a commission invoice is made out to.

registration_number
string | null
logo_signed_id
string | null

A signed_id from POST /files; null removes the image.

square_logo_signed_id
string | null

A signed_id from POST /files; null removes the image.

cover_photo_signed_id
string | null

A signed_id from POST /files; null removes the image.

holiday_mode_until
string<date-time> | null

Set while the seller is away: the catalog stays but stops selling. null ends holiday mode.

billing_address
object
custom_fields
object[]

Answers to the custom fields this marketplace's onboarding asks for. A field nothing asked for is ignored rather than written.

accept_terms
boolean

Stamps the moment the seller accepted the marketplace's terms. One-way: sending false does not unmake the stamp.

Response

profile updated

id
string
required
name
string
required
slug
string
required
about
string
required
about_html
string
required
logo_url
string | null
required
square_logo_url
string | null
required
cover_photo_url
string | null
required
timezone
required

Common IANA time zones; any other IANA time zone identifier is accepted too.

Available options:
Africa/Algiers,
Africa/Cairo,
Africa/Casablanca,
Africa/Harare,
Africa/Johannesburg,
Africa/Monrovia,
Africa/Nairobi,
America/Argentina/Buenos_Aires,
America/Asuncion,
America/Bogota,
America/Caracas,
America/Chicago,
America/Chihuahua,
America/Denver,
America/Guatemala,
America/Guyana,
America/Halifax,
America/Indiana/Indianapolis,
America/Juneau,
America/La_Paz,
America/Lima,
America/Los_Angeles,
America/Mazatlan,
America/Mexico_City,
America/Monterrey,
America/Montevideo,
America/New_York,
America/Nuuk,
America/Phoenix,
America/Puerto_Rico,
America/Regina,
America/Santiago,
America/Sao_Paulo,
America/St_Johns,
America/Tijuana,
Asia/Almaty,
Asia/Baghdad,
Asia/Baku,
Asia/Bangkok,
Asia/Chongqing,
Asia/Colombo,
Asia/Dhaka,
Asia/Hong_Kong,
Asia/Irkutsk,
Asia/Jakarta,
Asia/Jerusalem,
Asia/Kabul,
Asia/Kamchatka,
Asia/Karachi,
Asia/Kathmandu,
Asia/Kolkata,
Asia/Krasnoyarsk,
Asia/Kuala_Lumpur,
Asia/Kuwait,
Asia/Magadan,
Asia/Muscat,
Asia/Novosibirsk,
Asia/Rangoon,
Asia/Riyadh,
Asia/Seoul,
Asia/Shanghai,
Asia/Singapore,
Asia/Srednekolymsk,
Asia/Taipei,
Asia/Tashkent,
Asia/Tbilisi,
Asia/Tehran,
Asia/Tokyo,
Asia/Ulaanbaatar,
Asia/Urumqi,
Asia/Vladivostok,
Asia/Yakutsk,
Asia/Yekaterinburg,
Asia/Yerevan,
Atlantic/Azores,
Atlantic/Cape_Verde,
Atlantic/South_Georgia,
Australia/Adelaide,
Australia/Brisbane,
Australia/Canberra,
Australia/Darwin,
Australia/Hobart,
Australia/Melbourne,
Australia/Perth,
Australia/Sydney,
Etc/GMT+12,
Europe/Amsterdam,
Europe/Athens,
Europe/Belgrade,
Europe/Berlin,
Europe/Bratislava,
Europe/Brussels,
Europe/Bucharest,
Europe/Budapest,
Europe/Copenhagen,
Europe/Dublin,
Europe/Helsinki,
Europe/Istanbul,
Europe/Kaliningrad,
Europe/Kiev,
Europe/Lisbon,
Europe/Ljubljana,
Europe/London,
Europe/Madrid,
Europe/Minsk,
Europe/Moscow,
Europe/Paris,
Europe/Prague,
Europe/Riga,
Europe/Rome,
Europe/Samara,
Europe/Sarajevo,
Europe/Skopje,
Europe/Sofia,
Europe/Stockholm,
Europe/Tallinn,
Europe/Vienna,
Europe/Vilnius,
Europe/Volgograd,
Europe/Warsaw,
Europe/Zagreb,
Europe/Zurich,
Pacific/Apia,
Pacific/Auckland,
Pacific/Chatham,
Pacific/Fakaofo,
Pacific/Fiji,
Pacific/Guadalcanal,
Pacific/Guam,
Pacific/Honolulu,
Pacific/Majuro,
Pacific/Midway,
Pacific/Noumea,
Pacific/Pago_Pago,
Pacific/Port_Moresby,
Pacific/Tongatapu,
UTC
status
required

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

Available options:
pending,
invited,
canceled,
onboarding,
ready_for_review,
approved,
rejected,
suspended
registration_number
string | null
required
contact_email
string | null
required
billing_email
string | null
required
tax_remittance
enum<string>
required
Available options:
seller,
platform
payouts_schedule_interval
enum<string> | null
required
Available options:
daily,
weekly,
biweekly,
monthly,
manual
holiday_mode_until
string | null
required
terms_accepted_at
string | null
required
created_at
string
required
minimum_payout_amount
string | null
required
on_holiday
boolean
required
sellable
boolean
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
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
products_count
number
required
custom_fields
object[]
policies
object[]
billing_address
object
returns_address
object