Show an export - Spree Commerce documentation

GET

api

admin

exports

{id}

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.get('exp_xxx')

{
  "id": "exp_UkLWZg9DAJ",
  "number": "EF706283958",
  "type": "Spree::Exports::Products",
  "format": "csv",
  "created_at": "2026-06-17T13:36:53.632Z",
  "updated_at": "2026-06-17T13:36:53.632Z",
  "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

Path Parameters

string

required

Response

200 - application/json

export found

Create an export

Delete 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.get('exp_xxx')

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