Skip to main content

Export Backorders

GET 
/api/v2/inventory-allocations/backorders/export

Downloads the backorder queue as an XLSX or CSV file.

Required scope: orders:read

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

Uses the same status scope, search, and grouped filter pipeline as List Backorders, so the export always matches what the user sees in the UI for the active status tab.

Scopes:

  • all — export every backorder in the current status tab, ignoring filters/search/sort
  • filtered (default) — honor all active filters, search, and sort
  • current_page — just the page currently rendered by the list view
  • selected — the IDs passed via the ids query param (comma-separated)

Columns: Pass columns as a comma-separated list of keys to limit the export to the visible list view columns (in request order). Omit columns to export every available column.

Response: Returns a binary download — application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for xlsx, text/csv for csv. Filename pattern: backorders-YYYY-MM-DD-HH-MM-SS.{format}.

Each backorder row also carries in_transit_stock (inbound stock in motion across warehouses), alongside other_warehouse_stock. Both are populated in the CSV/XLSX export.

Request​

Responses​

OK

Response Headers
    Content-Type
    Content-Disposition