Skip to main content

Export Warehouse Transfers

GET 
/api/v2/warehouse-transfers/export

Download warehouse transfers as an XLSX or CSV file. Requires export permission for warehouse transfers.

Required scope: warehouses:read

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

Export controls:

  • format — xlsx (default) or csv.
  • content_mode — summary (default, one row per transfer) or line_items (one row per transfer line, with the transfer columns repeated and line columns appended: Line ID, Item SKU, Item Name, Item Description, Item Qty, Cancelled Qty, Item FNSKU).
  • scope — filtered (default: respects active filters/search), all (ignores filters), current_page (only the current page of the list), or selected (only the IDs passed in ids).
  • ids — comma-separated transfer IDs; required when scope=selected.
  • columns — comma-separated column keys to restrict/reorder transfer-level columns. Available keys: id, warehouse_transfer_number, transfer_date, from_warehouse, to_warehouse, transfer_type, status, shipment_status, receipt_status, shipping_method, shipment_id, line_item_count, eta, fully_shipped_at, fully_received_at, tags, created_at, updated_at (plus any custom-field columns defined for transfers).

Filters (same set as List Warehouse Transfers; applied when scope is filtered or current_page):

  • filter[search] — matches transfer ID, transfer number, from/to warehouse name, item SKU, and item FNSKU.
  • filter[archived] — archived visibility: omit for non-archived only, only for archived only, all for everything.
  • filter[include_deleted] — include adds deleted transfers, only returns just deleted ones.
  • filter[transfer_status.{op}], filter[shipment_status.{op}], filter[receipt_status.{op}] — text operators; receipt_status also accepts the special value received_for_less.
  • filter[transfer_type.{op}] — values: standard, fba_inbound, awd_inbound, awd_fba_replenishment; operators: is, is_not, is_one_of, is_not_one_of.
  • filter[has_blemished.is]=1 / filter[has_inbound_plan.is]=1 — flag filters (is / is_not).
  • filter[id.{op}] — numeric operators.
  • filter[from_warehouse.{op}], filter[to_warehouse.{op}] — warehouse ID, text operators.
  • filter[transfer_date.{op}], filter[created_at.{op}], filter[updated_at.{op}] — date operators.

Text operators: contains, does_not_contain, is, is_not, is_one_of, is_not_one_of, starts_with, does_not_start_with, ends_with, does_not_end_with, is_empty, is_not_empty. Numeric operators: is, is_not, is_one_of, is_not_one_of, greater_than, less_than, greater_than_or_equal, less_than_or_equal, between, is_empty, is_not_empty. Date operators: is, is_not, before, after, on_or_before, on_or_after, between, is_empty, is_not_empty, today, yesterday, tomorrow, past_week, past_month, past_year, next_week, next_month, next_year, days_ago, days_from_now, past_days, next_days.

filter_groups — base64-encoded JSON tree for nested AND/OR filter groups over the same columns.

Sorting: sort with optional - prefix for descending. Allowed sorts: id, warehouse_transfer_number, transfer_date, transfer_status, shipment_status, receipt_status, created_at, updated_at, eta, archived_at, asn_last_sent_at, status, from_warehouse_name, to_warehouse_name, from_warehouse, to_warehouse. Default: -transfer_date.

Response: binary file download (Content-Type application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for xlsx, text/csv for csv).

Authentication: Requires Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type
    Content-Disposition