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

Body

application/json
type
enum<string>
required
Available options:
Spree::Exports::Products,
Spree::Exports::Orders,
Spree::Exports::Customers,
Spree::Exports::ProductTranslations,
Spree::Exports::GiftCards,
Spree::Exports::CouponCodes,
Spree::Exports::NewsletterSubscribers
Example:

"Spree::Exports::Products"

record_selection
enum<string>

Set to "all" to ignore search_params and export everything in scope.

Available options:
filtered,
all
Example:

"filtered"

search_params
object

Ransack query hash. Same predicates accepted by the list endpoint.

Example:
results_url
string

Absolute URL of your admin exports view; the export-done email uses it as the download button target. Only honored when it matches one of the store's configured allowed origins.

Example:

"https://admin.example.com/store_abc/exports"

Response

201 - application/json

export queued