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

Path Parameters

id
string
required

Seller prefixed ID

Body

application/json
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.

name
string
Example:

"Northwind Books"

slug
string

URL-safe slug, derived from the name when omitted.

Example:

"northwind-books"

contact_email
string | null
Example:

"hi@northwind.example"

billing_email
string | null
Example:

"billing@northwind.example"

about
string | null

Sanitized HTML: the seller's public description.

Example:

"<p>Independent bookshop.</p>"

logo_signed_id
string | null

A signed_id from the files upload endpoint to set the image, null to remove it, or omit the key to leave it untouched. The same applies to square_logo_signed_id and cover_photo_signed_id.

square_logo_signed_id
string | null
cover_photo_signed_id
string | null
tax_remittance
enum<string>
Available options:
seller,
platform
Example:

"seller"

payouts_schedule_interval
enum<string> | null
Available options:
daily,
weekly,
biweekly,
monthly,
manual
minimum_payout_amount
string<decimal> | null
Pattern: ^-?\d+(\.\d+)?$
Example:

"25.0"

holiday_mode_until
string<date-time> | null

Set while the seller is away: the catalog stays but stops selling.

registration_number
string | null
metadata
object
billing_address
object

The seller's own billing address, written inline. There is no billing_address_id: an address belongs to whoever it was created for, so it is never referenced by id.

custom_fields
object[]

Custom field values, each validated against its definition.

Response

seller address written inline

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
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
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
metadata
object | null
required
holiday_mode_until
string | null
required
terms_accepted_at
string | null
required
created_at
string
required
updated_at
string
required
deleted_at
string | null
required
minimum_payout_amount
string | null
required
on_holiday
boolean
required
sellable
boolean
required
products_count
number
required
users_count
number
required
onboarding_progress
object
required
onboarding_complete
boolean
required
registration_number
string | null
required
billing_address
object
returns_address
object