Create an export

import { createAdminClient } from '@spree/admin-sdk' const client = createAdminClient({ baseUrl: 'https://your-store.com', secretKey: 'sk_xxx', }) const exp = await client.exports.create({ type: 'products', search_params: { name_cont: 'shirt' }, })

{ "id": "exp_gbHJdmfrXB", "number": "EF1002", "format": "csv", "created_at": "2026-01-15T12:00:00.000Z", "updated_at": "2026-01-15T12:00:00.000Z", "type": "products", "user_id": "adm_UkLWZg9DAJ", "done": false, "store_id": "store_UkLWZg9DAJ", "seller_id": null, "seller_name": null, "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

string

required

Which dataset to export, as its shorthand: products, orders, customers, product_translations, gift_cards, coupon_codes, newsletter_subscribers, price_list_prices, purchase_orders, or a type an extension registers.

Example:

"products"

record_selection

enum<string>

filtered (the default) keeps search_params; all ignores them and exports every record in scope.

Available options:

filtered,

all

Example:

"filtered"

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 allowed origins.

Example:

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

search_params

object

A Ransack query, with the predicates the list endpoint accepts. A price_list_prices export requires price_list_id_eq naming a price list of the current store, and refuses record_selection: "all".

Example:

{ "name_cont": "shirt" }

Response

201 - application/json

export queued

API basics

Endpoints

Authorizations

Headers

Body

Response