Skip to main content

Release Backorders and Dispatch Fulfillment

POST 

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

Releases the given backorders against on-hand stock and dispatches fulfillment for their orders in one call.

Required scope: orders:write

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

Each allocation moves from planned / awaiting_receipt to allocated, claiming the stock, and a fulfillment is then created for every affected sales order — matching what happens automatically when stock arrives.

Availability is re-checked under a pool lock at release time, so a backorder whose stock was claimed by another operation since the list was fetched is reported in skipped rather than over-allocated. Fulfillment is only dispatched when at least one backorder was released.

Pair with GET /api/v2/inventory-allocations/releasable-backorders to obtain eligible ids. To release without dispatching fulfillment, use POST /api/v2/inventory-allocations/release-selected instead.

Body:

  • ids — Array of allocation IDs to release (required, at least one integer)

Request

Responses

OK

Response Headers
    Content-Type