Place lot-level Hold (with optional BOM cascade)

curl --request POST \
  --url https://{base_url_domain}/api/global/v1/inventory/holds/lot \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "lot_id": 142,
  "reason_code": "recalled",
  "cascade_bom": false,
  "notes": "Recall #123"
}
'

{
  "origin": {
    "lot_id": 142,
    "created_origin_hold_ids": [
      501,
      502,
      503
    ]
  }
}

Holds

Place lot-level Hold (with optional BOM cascade)

Places holds on every active putaway location currently carrying the named lot.

cascade_bom=false (default) — the engine’s Hold::placeByLot path. Each affected location gets a location-scope stock_hold row with parent_hold_id=NULL.

cascade_bom=true — the engine’s Hold::cascadeLotHold path. The hold cascades through the BOM lineage discovered via work_lot_input / work_component_lot. The response carries cascade.release_mode as a hint for downstream tooling, but cascaded holds must currently be freed per-id via POST /v1/inventory/holds/{id}/release using origin.created_origin_hold_ids ∪ cascade.child_hold_ids.

Do not blindly release origin.root_hold_ids — 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.

POST

inventory

holds

lot

Place lot-level Hold (with optional BOM cascade)

curl --request POST \
  --url https://{base_url_domain}/api/global/v1/inventory/holds/lot \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "lot_id": 142,
  "reason_code": "recalled",
  "cascade_bom": false,
  "notes": "Recall #123"
}
'

{
  "origin": {
    "lot_id": 142,
    "created_origin_hold_ids": [
      501,
      502,
      503
    ]
  }
}

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

lot_id

integer<int64>

required

Lot to hold.

Example:

142

reason_code

string

required

Hold reason code.

Example:

"recalled"

cascade_bom

boolean

default:false

Cascade through BOM lineage.

Example:

false

notes

string | null

Free-form notes attached to the holds placed by this call.

Example:

"Recall #123"

Response

Lot hold placed.

origin

object

required

Show child attributes

cascade

object

Present only when cascade_bom=true.

Show child attributes

Place location-level Hold

Release one Hold by ID