Skip to main content

Export Purchase Orders

GET 
/api/purchase-orders/list/export

Export purchase orders as XLSX or CSV. Supports summary (one row per PO) and line_items (one row per line item with PO fields repeated) modes.

Required scope: purchase-orders:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token.

Response: Binary file download (XLSX or CSV).

Delivery depends on size: up to 1,000 purchase orders (or scope=current_page) the response is the file itself. Above 1,000 purchase orders the export runs as a background job and the response is JSON carrying tracked_job_log_id and queued=true; when the job completes, its results include download_url and file — fetch the file with Download Purchase Orders Export. Background xlsx exports above 15,000 purchase orders are written as CSV instead.

Scope options:

  • filtered: Apply active filters (default)
  • all: Export all POs ignoring filters
  • current_page: Export current page only
  • selected: Export specific IDs (pass ids=1,2,3)

Line item columns (always included in line_items mode): item_sku, item_barcode, item_name, item_description, item_quantity, item_received_qty, item_price, item_discount_rate, item_tax_rate, item_line_total, item_eta.

Requires permission: purchase_orders.export

Request​

Responses​

OK

Response Headers
    Content-Type