Skip to main content

Export Backorders

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

Downloads the backorder queue as an XLSX or CSV file.

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 datatable
  • 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 datatable 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}.

Request​

Responses​

OK

Response Headers
    Content-Type
    Content-Disposition