Skip to main content
POST
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
type
enum<string>
required

Which dataset to export.

Available options:
orders,
products
record_selection
enum<string>

filtered (default) keeps search_params; all exports everything this seller owns.

Available options:
filtered,
all
search_params
object

Ransack predicates, the same shape the list endpoints take. Ignored when record_selection is all.

results_url
string

Panel URL the export-done email links back to. Honored only when it matches one of the store's allowed origins.

Response

export queued

id
string
required
number
string
required
format
string | null
required
created_at
string
required
updated_at
string
required
type
string | null
required
user_id
string | null
required
done
boolean
required
filename
string | null
required
byte_size
number | null
required
download_url
string | null
required