Skip to main content
POST
Release all active Holds on Lot

Authorizations

Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

lot_id
integer<int64>
required

Lot whose holds to release.

Body

application/json
release_cascaded
boolean
default:false

Also release the related lots quarantined under this lot.

Response

Lot release outcome.

lot_id
integer<int64>
required

Lot whose holds were targeted by this release call.

released_hold_ids
integer<int64>[]
required

Hold IDs newly released by this call, including related-lot holds when release_cascaded=true. Empty when nothing was active.

requarantined_lot_ids
integer<int64>[]
required

Lots this call released that stay quarantined: an open quarantine still covers them (another lot's, or their own after an Expired hold had replaced their place in it), so they moved into it, held with that quarantine's reason. Empty when no lot moved.