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

# Export orders

> The orders the same filters would list, as a CSV file: a row an order with every field its page shows (when it was paid, the fee, tax, balance and affiliate in it, the currency it was charged in, the billing address), or a row a product line with `rows=lines`. The first thirteen columns are always Order ID, Created, Email, Status, Payment, Currency, Subtotal, Discount, Total, Coupon, Country, Items and Products, in that order. No delivered key is in it. Every order the filters match is in the file, however many: it is sent as it is read, with no length given. Add `check=1` for `{ rows }`, how many it would have, which is not counted. A store exports at most 30 files every 10 minutes, orders, customers, fraud events and blacklist rules together, whoever asks: after that the answer is 429.

Needs the `orders.read` permission (Read Orders). It is one of the heavier reads, and is counted against a smaller budget of its own: 60 a minute for each key.



## OpenAPI

````yaml /api-reference/openapi.json get /stores/{storeId}/orders/export
openapi: 3.1.0
info:
  title: Shoply API
  version: '1'
  description: >-
    Everything a store's own server can do with a secret API key: its catalogue,
    orders, customers, marketing, finance and the rest of what the dashboard
    does. And the Customer API, which a buyer's own device asks with a token of
    theirs.
servers:
  - url: https://api.shoply.gg/v1
security:
  - apiKey: []
tags:
  - name: API key
  - name: Store
  - name: Domain
  - name: Payment methods
  - name: Analytics
  - name: Storefronts
  - name: Storefront code
  - name: Payment Routing
  - name: Custom payment methods
  - name: Products
  - name: Product pictures
  - name: Stock
  - name: Categories
  - name: Upsells
  - name: Subscriptions
  - name: Orders
  - name: Invoices
  - name: Reviews
  - name: Coupons
  - name: Coupon categories
  - name: Coupon pop-up
  - name: Sales
  - name: Blog
  - name: Search settings
  - name: Redirects
  - name: Sitemap
  - name: Cart Recovery
  - name: Email Marketing
  - name: Email Templates
  - name: Customers
  - name: Affiliates
  - name: Support Tickets
  - name: Blacklist
  - name: Fraud protection
  - name: Disputes
  - name: Finance
  - name: Tax
  - name: Expenses
  - name: Expense setup
  - name: API requests
  - name: Webhook endpoints
  - name: Webhook deliveries
  - name: Customer API
paths:
  /stores/{storeId}/orders/export:
    get:
      tags:
        - Orders
      summary: Export orders
      description: >-
        The orders the same filters would list, as a CSV file: a row an order
        with every field its page shows (when it was paid, the fee, tax, balance
        and affiliate in it, the currency it was charged in, the billing
        address), or a row a product line with `rows=lines`. The first thirteen
        columns are always Order ID, Created, Email, Status, Payment, Currency,
        Subtotal, Discount, Total, Coupon, Country, Items and Products, in that
        order. No delivered key is in it. Every order the filters match is in
        the file, however many: it is sent as it is read, with no length given.
        Add `check=1` for `{ rows }`, how many it would have, which is not
        counted. A store exports at most 30 files every 10 minutes, orders,
        customers, fraud events and blacklist rules together, whoever asks:
        after that the answer is 429.


        Needs the `orders.read` permission (Read Orders). It is one of the
        heavier reads, and is counted against a smaller budget of its own: 60 a
        minute for each key.
      operationId: orders.export
      parameters:
        - name: storeId
          in: path
          required: true
          description: >-
            The store's ID. A key reaches the store it was made in: `GET /key`
            answers which.
          schema:
            type: string
        - name: status
          in: query
          required: false
          description: Only orders in this status.
          schema:
            type: string
            enum:
              - pending
              - completed
              - refunded
              - cancelled
              - chargeback
        - name: gateway
          in: query
          required: false
          description: >-
            Only orders paid with this payment method, by its name in the
            payment methods list.
          schema:
            type: string
            example: stripe
        - name: search
          in: query
          required: false
          description: An order's ID, or part of a buyer's email.
          schema:
            type: string
        - name: sort
          in: query
          required: false
          description: What the list is ordered by.
          schema:
            type: string
            enum:
              - created_at
              - amount
              - email
              - status
            default: created_at
        - name: direction
          in: query
          required: false
          description: Which way it is ordered.
          schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
        - name: range
          in: query
          required: false
          description: Only orders placed in this period.
          schema:
            type: string
            enum:
              - today
              - yesterday
              - 7d
              - 30d
              - this_week
              - last_week
              - this_month
              - last_month
              - this_year
        - name: from
          in: query
          required: false
          description: >-
            Only orders placed on or after this day, as `YYYY-MM-DD`. With `to`,
            in place of `range`.
          schema:
            type: string
            example: '2026-10-01'
        - name: to
          in: query
          required: false
          description: Only orders placed on or before this day, as `YYYY-MM-DD`.
          schema:
            type: string
            example: '2026-10-31'
        - name: tz
          in: query
          required: false
          description: >-
            The time zone the days of `range`, `from` and `to` are in, as an
            IANA name. Left out, UTC.
          schema:
            type: string
            example: Europe/Berlin
        - name: rows
          in: query
          required: false
          description: 'What a row is: an order, or one product line of one.'
          schema:
            type: string
            enum:
              - orders
              - lines
            default: orders
        - name: check
          in: query
          required: false
          description: >-
            `1` for how many rows the file would have, as `{ rows }`, in place
            of the file. Not counted against the store's exports, and refused
            with 429 where none are left.
          schema:
            type: string
            enum:
              - '1'
      responses:
        '200':
          description: The file itself, not a JSON envelope.
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '401':
          $ref: '#/components/responses/NoKey'
        '403':
          $ref: '#/components/responses/NotAllowed'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooMany'
      x-codeSamples:
        - lang: javascript
          label: Node.js
          source: |
            import Shoply from "@shoplygg/node";

            const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });

            const file = await shoply.orders.export();
            const text = await file.text();
        - lang: php
          label: PHP
          source: |
            <?php

            require 'vendor/autoload.php';

            $shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);

            $file = $shoply->orders->export();
            $file->save('export');
        - lang: python
          label: Python
          source: |
            import shoply

            client = shoply.Client()  # reads SHOPLY_API_KEY

            file = client.orders.export()
            file.save("export")
components:
  responses:
    NoKey:
      description: >-
        No API key was sent, or the one sent is not a live key:
        `api_key_required`, `invalid_api_key`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    NotAllowed:
      description: >-
        The key is real and may not do this: `missing_scope` (with
        `requiredScope`), `ip_not_allowed`, `account_unavailable`, or
        `dashboard_only` for something only a person in the dashboard may do.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    NotFound:
      description: >-
        There is no such thing in this store: `not_found`. A store that is not
        the key's own is answered the same way.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    TooMany:
      description: >-
        The key has used up its budget for now: `rate_limited`. `Retry-After`
        says how many seconds to wait.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
  schemas:
    Refusal:
      type: object
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          description: What is wrong, in words for a person.
        code:
          type: string
          description: What is wrong, as a word that does not change.
        data:
          nullable: true
        errors:
          type: object
          description: >-
            For `validation_failed`: what is wrong with each field, by the
            field's name.
          additionalProperties:
            type: string
      required:
        - success
        - message
        - code
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        A secret API key, made under Developers in the dashboard:
        `Authorization: Bearer shoply_sk_...`

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.