> ## Documentation Index
> Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 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:** `write_exports` (for API-key authentication).



## OpenAPI

````yaml /api-reference/admin.yaml post /api/v3/admin/exports
openapi: 3.0.3
info:
  title: Admin API
  contact:
    name: Spree Commerce
    url: https://spreecommerce.org
    email: hello@spreecommerce.org
  description: >
    Spree Admin API v3 - Administrative API for managing products, orders, and
    store settings.


    ## Authentication


    The Admin API requires a secret API key passed in the `x-spree-api-key`
    header.

    Secret API keys can be generated in the Spree admin dashboard.


    ## Response Format


    All responses are JSON. List endpoints return paginated responses with
    `data` and `meta` keys.

    Single resource endpoints return a flat JSON object.


    ## Resource IDs


    Every resource is identified by an opaque string ID (e.g. `prod_86Rf07xd4z`,

    `variant_k5nR8xLq`, `or_UkLWZg9DAJ`). Use these IDs everywhere — URL paths,

    request bodies, and Ransack filters all accept them directly.


    ## Error Handling


    Errors return a consistent format:

    ```json

    {
      "error": {
        "code": "validation_error",
        "message": "Validation failed",
        "details": { "name": ["can't be blank"] }
      }
    }

    ```
  version: v3
servers:
  - url: http://{defaultHost}
    variables:
      defaultHost:
        default: localhost:3000
security: []
tags:
  - name: Authentication
    description: Admin user authentication
  - name: Product Catalog
    description: Products, variants, and option types
  - name: Orders
    description: >-
      Order management — orders, items, payments, fulfillments, refunds, gift
      cards, store credits
  - name: Customers
    description: Customer management — profiles, addresses, store credits, credit cards
  - name: Configuration
    description: Store configuration — payment methods, tag autocomplete
paths:
  /api/v3/admin/exports:
    post:
      tags:
        - Exports
      summary: Create an export
      description: >-
        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:** `write_exports` (for API-key authentication).
      parameters:
        - name: x-spree-api-key
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - type
              properties:
                type:
                  type: string
                  enum:
                    - 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:
                  type: string
                  enum:
                    - filtered
                    - all
                  description: >-
                    Set to "all" to ignore search_params and export everything
                    in scope.
                  example: filtered
                search_params:
                  type: object
                  description: >-
                    Ransack query hash. Same predicates accepted by the list
                    endpoint.
                  example:
                    name_cont: shirt
                  additionalProperties: true
      responses:
        '201':
          description: export queued
          content:
            application/json:
              example:
                id: exp_gbHJdmfrXB
                number: EF329172445
                type: Spree::Exports::Products
                format: csv
                created_at: '2026-06-05T13:12:05.895Z'
                updated_at: '2026-06-05T13:12:05.895Z'
                user_id: admin_UkLWZg9DAJ
                done: false
                filename: null
                byte_size: null
                download_url: null
      security:
        - api_key: []
          bearer_auth: []
      x-codeSamples:
        - lang: javascript
          label: Spree Admin SDK
          source: |-
            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' }
            })
components:
  securitySchemes:
    api_key:
      type: apiKey
      name: x-spree-api-key
      in: header
      description: Secret API key for admin access
    bearer_auth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token for admin user authentication

````