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.
purchase-orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Response: Binary file download (XLSX or CSV).
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
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.