Create an export

Queues a CSV export. The type selects the dataset; search_params is an optional Ransack query (same shape used by the q[...] params on list endpoints) that filters which records are exported. Pass record_selection: "all" to clear the filter server-side and export everything in scope.

Generation is asynchronous. Poll GET /admin/exports/{id} until done is true, then redirect the browser to download_url to fetch the file.

Required scope: the read scope of the exported resource — read_products for product exports, read_customers for customer exports, etc. (for API-key authentication).

POST

api

admin

exports

Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

const exp = await client.exports.create({
  type: 'Spree::Exports::Products',
  search_params: { name_cont: 'shirt' }
})

{
  "id": "exp_gbHJdmfrXB",
  "number": "EF906940928",
  "type": "Spree::Exports::Products",
  "format": "csv",
  "created_at": "2026-06-17T13:36:53.357Z",
  "updated_at": "2026-06-17T13:36:53.357Z",
  "user_id": "admin_UkLWZg9DAJ",
  "done": false,
  "filename": null,
  "byte_size": null,
  "download_url": null
}

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:

{ "name_cont": "shirt" }

Response

201 - application/json

export queued

List exports

Show an export

⌘I

Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

const exp = await client.exports.create({
  type: 'Spree::Exports::Products',
  search_params: { name_cont: 'shirt' }
})

{
  "id": "exp_gbHJdmfrXB",
  "number": "EF906940928",
  "type": "Spree::Exports::Products",
  "format": "csv",
  "created_at": "2026-06-17T13:36:53.357Z",
  "updated_at": "2026-06-17T13:36:53.357Z",
  "user_id": "admin_UkLWZg9DAJ",
  "done": false,
  "filename": null,
  "byte_size": null,
  "download_url": null
}