Skip to main content
POST
Place location-level Hold

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.

Body

application/json
location_id
integer<int64>
required

Target location.

Example:

6

reason_code
string
required

Hold reason code (system or user-defined).

Example:

"damaged"

qty
number<float>
required

Quantity to hold (must be > 0 and equal to the location's full holdable qty). Partial holds are not currently supported.

Example:

5

notes
string | null

Free-form notes.

Example:

"Damaged at receiving"

Response

Hold placed.

resource
Hold · object

An inventory hold record. Cross-merchant view (Global API surface).

Releasing cascaded holds: when holdLot is called with cascade_bom=true, free the cascade tree by releasing each child via POST /holds/{id}/release, using origin.created_origin_hold_ids ∪ cascade.child_hold_ids from the original holdLot response.

Do not include origin.root_hold_ids blindly in the release set — those may include pre-existing roots from a prior cascadeLotHold call that this call attached children to, and releasing them would also release siblings the current caller did not place.