Skip to content

Data exports

Open .md

API reference Imports and exports

Whole-team CSV exports from the Download Center: customers, products, sales orders, invoices, payments, tax and purchase orders. They run in the background; poll, then download.

Learn more: Export and import data

16 operations

  • GETList data exports/v1/api/store/{team_slug}/data_exportLists your team's exports, newest first, 15 per page: everyone's, of every type and status, including exports whose file has expired.
  • GETList export types and their columns/v1/api/store/{team_slug}/data_export/definitionsReturns every export type with the columns you can ask for.
  • GETList export column presets/v1/api/store/{team_slug}/data_export/presetsLists the saved column choices (presets) you can use: the team's shared presets, and your own personal ones.
  • GETGet a data export/v1/api/store/{team_slug}/data_export/{id}Returns one export.
  • POSTSave an export column preset/v1/api/store/{team_slug}/data_export/presetsSaves a named set of columns for one export type.
  • DELETEDelete an export column preset/v1/api/store/{team_slug}/data_export/presets/{presetId}Deletes a preset for good.
  • GETDownload a data export's file/v1/api/store/{team_slug}/data_export/{id}/downloadSends the export's CSV file itself, not JSON and not a link.
  • POSTExport all customers to CSV/v1/api/store/{team_slug}/data_export/export_customerStarts a CSV export of every customer on your team (deleted customers are left out).
  • POSTExport invoices in a date range to CSV/v1/api/store/{team_slug}/data_export/export_invoiceStarts a CSV export of invoices, one row per invoice, with the order, customer, shipping address, totals and payments.
  • POSTExport invoice line items in a date range to CSV/v1/api/store/{team_slug}/data_export/export_invoice_itemStarts a CSV export with one row per invoice line item: the order, invoice, job, product, services, quantity and totals.
  • POSTExport payments and refunds in a date range to CSV/v1/api/store/{team_slug}/data_export/export_payment_listStarts a CSV export of payments and refunds recorded on your team's orders, one row per payment or refund, with its amount, method and reference.
  • POSTExport purchase orders in a date range to CSV/v1/api/store/{team_slug}/data_export/export_purchase_order_listStarts a CSV export of purchase orders whose issue date falls in the range, one row per purchase order, with the vendor, status, ordered and received totals, and the related sales orders and customers.
  • POSTExport sales orders in a date range to CSV/v1/api/store/{team_slug}/data_export/export_sales_orderStarts a CSV export of your team's sales orders whose chosen date (date_field) falls in the range.
  • POSTExport all simple products to CSV/v1/api/store/{team_slug}/data_export/export_simple_product_listStarts a CSV export of your team's custom simple products (deleted products are left out).
  • POSTExport the tax report for a date range to CSV/v1/api/store/{team_slug}/data_export/export_taxStarts a CSV export of the tax report.
  • POSTExport all variant products to CSV/v1/api/store/{team_slug}/data_export/export_variant_product_listStarts a CSV export of your team's custom variant products, one row per variant (size and color).