Skip to main content

List Releasable Backorders

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

Backorders whose stock is already on hand in the warehouse the backorder is assigned to, and which a release would therefore promote immediately.

Required scope: orders:read

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

Backorder release runs when stock arrives and is not retried, so a backorder raised against stock that was already on hand — or one whose release did not run — stays open indefinitely while the units sit unallocated. This endpoint returns exactly those rows.

Availability is evaluated per (product, warehouse) pool: physical stock minus what is already allocated, on hold, or in a non-sellable location. Rows are consumed in release priority order, so when several backorders queue on one pool only those the pool can actually cover are returned.

Rows where releasing would be incorrect are excluded: orders that are cancelled or closed, lines the sales channel has already shipped, and lines with no quantity left to ship. Orders held to a future date ARE included — releasing reserves stock rather than shipping it, and the hold is reported per row in hold_until_date.

count, units and orders describe the whole set; rows is capped by limit, so compare scanned_count against count (or read truncated) before treating the list as complete.

Release the returned rows with POST /api/v2/inventory-allocations/releasable-backorders/release.

Request​

Responses​

OK

Response Headers
    Content-Type