Backordered SKUs Report

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
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1

Only applicable for organizations. Filters items by the specified client_id, provided the client_id belongs to the organization. Note: API keys can belong to either client level or organization level.

integer
≥ 1

Only include backorders from open orders assigned to this warehouse.

string

Only include backorders from open orders in these stores, as a comma-separated list of store IDs (e.g. 12,15).

string
enum

The column to sort by. Defaults to orders_released_immediately (descending) — the SKUs unblocking the most orders first.

string

A value to search for within the items. The specific fields searched depend on the endpoint.

integer
1 to 100
Defaults to 25

The maximum number of items to return in the response. Used for pagination. Must be between 1 and 100.

string

A cursor for pagination. Use the next_cursor value from a previous response to fetch the next page of results. This provides more efficient pagination than offset-based pagination, especially for large datasets. Cannot be used together with the offset parameter.

string
enum
Defaults to asc

Specifies the sort direction of the returned items:

  • asc: Ascending order. For dates, this means from oldest to newest. For numbers, this means from smallest to largest.
  • desc: Descending order. For dates, this means from newest to oldest. For numbers, this means from largest to smallest.
Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json