Export sales orders as CSV

POST/v1/api/store/{team_slug}/sales_order/export

v1Operation ID v1_public_sales_order_export

Downloads a CSV file of the published sales orders whose issue date is in a range. Quotes and drafts are left out; use Export quotes for quotes.

Send start_date and end_date as ISO 8601 date-times, for example 2026-11-01T00:00:00Z and 2026-11-30T23:59:59Z. They are compared as given, so a date alone means midnight UTC and an end date of 2026-11-30 leaves out most of that day.

The file has one row per order with these columns: order_id (the number), issue_date, creator, customer_po_number, customer_email, customer_contact_name, customer_name, customer_tax_exempt, customer_brand_profile, pricing_group, payment_term, pricing_strategy, warehouse, production_start_date, production_due_date, shipment_due_date, customer_in_hand_date, client_note, prod_note, jobs, status, subtotal, discount, tax, total, balance_due, paid, last_payment_date and tags. Dates are YYYY-MM-DD in the team's time zone. Amounts are decimal strings with 2 decimal places: subtotal is the value of the order's lines, while discount, tax, total and balance_due count only what has been invoiced (0.00 until then). paid and customer_tax_exempt are TRUE or FALSE.

With list_only: true the same rows come back as JSON in data, each with the order's name as well; an empty range then answers data: [] instead of 422. The answer is built at once; for large ranges, use the data export instead.

Permission

Needs the view_report permission.

Business rules

• start_date and end_date are required.
• Finds published sales orders only (not quotes, drafts or deleted orders).

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team

Request body

application/json, required.

• end_datestring (date-time)required

  End of the issue date range (ISO 8601).

• start_datestring (date-time)required

  Start of the issue date range (ISO 8601).

• list_onlyboolean

  true to get the rows as JSON instead of a CSV file.

Response

200The CSV file, or with list_only: true the rows as JSON.

• dataarray of objectsrequired
  Fields of each item (30)

  • balance_duestring

    Invoiced total minus paid. A decimal string with 2 decimal places, such as "1250.00"; parse it as a decimal.

  • client_notestring | null
  • creatorstring

    Created By's name, or an empty string.

  • customer_brand_profilestring | null
  • customer_contact_namestring | null
  • customer_emailstring | null
  • customer_in_hand_datestring

    YYYY-MM-DD, or an empty string.

  • customer_namestring | null
  • customer_po_numberstring | null
  • customer_tax_exemptstring
    • One of: "TRUE", "FALSE"
  • discountstring

    Invoiced discount; "0.00" until invoiced. A decimal string with 2 decimal places, such as "1250.00"; parse it as a decimal.

  • issue_datestring

    YYYY-MM-DD in the team's time zone.

  • jobsstring | null

    The jobs, one per line.

  • last_payment_datestring | null
  • namestring | null

    The order's name. JSON rows only: the CSV file has no name column.

  • order_idstring

    The order number (not the id).

  • paidstring

    TRUE when the invoiced total is paid.

    • One of: "TRUE", "FALSE"
  • payment_termstring | null
  • pricing_groupstring | null
  • pricing_strategystring | null
  • prod_notestring | null
  • production_due_datestring

    YYYY-MM-DD, or an empty string.

  • production_start_datestring

    YYYY-MM-DD, or an empty string.

  • shipment_due_datestring

    YYYY-MM-DD, or an empty string.

  • statusstring | null

    The status label.

  • subtotalstring

    The value of the order's lines. A decimal string with 2 decimal places, such as "1250.00"; parse it as a decimal.

  • tagsstring | null

    Tag names, comma-separated.

  • taxstring

    Invoiced tax; "0.00" until invoiced. A decimal string with 2 decimal places, such as "1250.00"; parse it as a decimal.

  • totalstring

    Invoiced total; "0.00" until invoiced. A decimal string with 2 decimal places, such as "1250.00"; parse it as a decimal.

  • warehousestring | null
• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

  When

  The role lacks view_report. This error has no envelope: the body is {"message": "Insufficient Permission"}.

  Fix

  Ask the team owner for report permission.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

• 422The request was refused and changed nothing. validation_failed lists what to fix in error.fields; other codes name a business rule, explained in error.message. A few checks answer with only {"message": "..."}. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer connect_timeout ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.

  When

  No sales order is in the range, for the file: sales_order_export_error "Sales Order not found". (With list_only: true the answer is data: [].)

  Fix

  Widen the range.

  When

  A date is missing or not ISO 8601.

  Fix

  Send both dates as ISO 8601.

Notes

• The CSV answer is a file (text/csv), not JSON.

Related

• POSTExport quotes as CSV/v1/api/store/{team_slug}/quote/export
• POSTExport sales orders in a date range to CSV/v1/api/store/{team_slug}/data_export/export_sales_order
• POSTList sales orders/v2/api/store/{team_slug}/v2/sales_order/filter

Example request

curl

curl -X POST 'https://secure.yoprint.com/v1/api/store/your-team/sales_order/export' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "end_date": "2026-11-30T23:59:59Z",    "list_only": false,    "start_date": "2026-11-01T00:00:00Z"  }'

Example response 200

Response

{
  "data": [
    {
      "balance_due": "85.00",
      "customer_name": "Northwind Apparel",
      "customer_tax_exempt": "FALSE",
      "discount": "0.00",
      "issue_date": "2026-11-03",
      "name": "Spring team shirts",
      "order_id": "SO1001",
      "paid": "FALSE",
      "status": "In production",
      "subtotal": "125.00",
      "tax": "10.00",
      "total": "135.00"
    }
  ],
  "status": 200,
  "success": true
}