Spree Admin SDK

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

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

// Fetch with the Bearer token, then drive the browser download:
const res = await fetch(exp.download_url, {
  headers: { Authorization: `Bearer ${token}` },
})
const blob = await res.blob()
const url = URL.createObjectURL(blob)
const a = Object.assign(document.createElement('a'), {
  href: url,
  download: exp.filename,
})
a.click()
URL.revokeObjectURL(url)

<string>

Download an export

Streams the exported CSV with Content-Disposition: attachment. Returns 422 with code: export_not_ready while done is still false. The endpoint is JWT/API-key protected, so SPA clients must fetch it (with Authorization header) and trigger the browser download via a Blob URL — a top-level navigation cannot carry the JWT.

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

GET

api

admin

exports

{id}

download

Spree Admin SDK

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

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

// Fetch with the Bearer token, then drive the browser download:
const res = await fetch(exp.download_url, {
  headers: { Authorization: `Bearer ${token}` },
})
const blob = await res.blob()
const url = URL.createObjectURL(blob)
const a = Object.assign(document.createElement('a'), {
  href: url,
  download: exp.filename,
})
a.click()
URL.revokeObjectURL(url)

<string>

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

string

required

Response

200 - text/csv

CSV file

The response is of type file.

⌘I

API basics

Endpoints

Download an export

Authorizations

Headers

Path Parameters

Response