Required permission: read_backordered_skus_report
Returns a product-centric report of SKUs that are blocking open orders from reaching Ready-to-Ship, along with the headline orders_released_immediately metric — the number of orders that would ship right away if that single SKU's backorder were resolved. This is the same report available in the Warehance UI, exposed for programmatic use (for example, to automatically generate kit assembly or purchasing tasks for the SKUs holding up the most orders).
All filter parameters are optional. Client-level API keys are automatically scoped to their client; organization-level API keys may optionally scope results to a single client they own via client_id.
This endpoint uses cursor-based pagination. Use the next_cursor value from a response in the cursor parameter of the next request to fetch the following page; has_next_page indicates whether more results remain. For performance, reports do not return total or filtered result counts.
Report data is cached briefly (about one minute) and may lag the most recent allocation changes by that interval.
Example use cases:
- Top SKUs releasing the most orders:
GET /reports/backordered-skus - For a single client:
GET /reports/backordered-skus?client_id=123 - Constrained to a warehouse:
GET /reports/backordered-skus?warehouse_id=4 - Sorted by total backordered quantity:
GET /reports/backordered-skus?sort_by=backordered_qty&order_by=desc
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
