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
override_requirements
boolean

Admits a seller whose onboarding checklist is unfinished: the operator's deliberate exception, which the seller.approved event records along with what was outstanding.

Response

seller approved

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