Sign in
Inventory Holds

Update Inventory Hold

Replaces the products covered by an inventory hold created through POST /v1/integrations/inventory-hold, addressed by the inventory_hold_uuid that call returned.

General description

  • The items list is the desired state: products missing from it are released, new ones are added and the rest is left untouched.
  • Just like creating a hold, this works only until the receiving starts being received.
post/v1/integrations/inventory-hold/update

Request body

inventory_hold_uuidstring required

Identifier of the inventory hold to update, as returned when it was created.

Example request

{
  "items": [
    {
      "lot": {
        "lot_number": "LOT-2025-001",
        "expiration_date": "2025-07-24"
      }
    }
  ]
}

Response

Success

inventory_hold_uuidstring required

Identifier of the inventory hold the call acted on.

messagestring required

Human-readable message describing what happened to the inventory hold.

Changes

Changed in 1 of the 6 revisions of this API.1