Release eligible Holds on Lot
Releases eligible active Holds for the specified Lot, regardless of reason. Holds owned by an open shortage count request remain active until the Location is counted or adjusted. The response lists only the Holds released by this call.
With release_cascaded=true the call also releases every hold placed under the lot’s
lot-level hold — the related lots quarantined with it by holdLot with cascade_bom=true,
in every warehouse — in the same transaction. Holds on those related lots that are not part
of that quarantine stay active: for example a separate location hold, or a lot-level hold
that existed before the cascade and was reused, together with the location holds the cascade
placed under it. The related lots are found also after the nightly expiry check replaced the
lot’s own lot-level hold with an Expired or Near Expiry hold. The quarantine ends with
this call: a related lot that is held by a hold outside the quarantine (for example its own
Expired hold) keeps that hold.
A lot that an open quarantine still covers does not become free: when the lot-level hold that
kept it out of that quarantine ends — its own older quarantine, or the Expired hold that
replaced its place in the quarantine — it moves into the quarantine and is listed in
requarantined_lot_ids.
When the lot was released earlier without release_cascaded, its related lots stay
quarantined. Releasing it again with release_cascaded=true releases them: every quarantine
the lot started that still holds related lots releases the holds it placed on them and ends.
Related lots that are held for another reason as well — their own older hold, or the
Expired hold of the nightly expiry check — keep that hold, leave the quarantine and are
listed in left_related_lot_ids; this also ends a quarantine whose related lots are all held
as Expired. The call also releases every eligible hold the lot itself got since, as it always does; to
release only the related lots and keep the lot’s own holds, use
POST /v1/inventory/holds/lot/{lot_id}/release-related-lots. While the lot is in a newer
quarantine of its own (it was quarantined again), only that quarantine and its related lots
are released; call again to release the related lots of the earlier ones, which
GET /v1/inventory/holds/lot/{lot_id} then lists in related_lot_ids.
reason_hold_ids releases only some of the reasons that hold the lot, as listed by
GET /v1/inventory/holds/lot/{lot_id} (reasons[].hold_id):
- the lot’s own lot-level hold (
is_own_hold=true) is released with its location holds; when a quarantine still covers the lot, the lot moves into it (requarantined_lot_ids) unless that quarantine’s id is passed too; - the id of a quarantine that covers the lot (
is_own_hold=false) takes the lot out of that quarantine without changing any hold, and the origin lot of that quarantine is listed inleft_origin_lot_ids.
With reason_hold_ids, release_cascaded=true is accepted only when the ids include the lot’s
own quarantine (is_group=true); otherwise the call returns 422 with a message that names what
to send instead, and repeating the same request does not help. An id that is not a current
reason of the lot, or a reason list that is out of date, also returns 422; nothing is released.
Authorizations
Body
Response
Lot release outcome.
Related lots that left a quarantine this call ended while they keep another hold
(their Expired hold or their own older hold). Empty when no quarantine ended.