Inventory Holds

Update Inventory Hold

Changed on

Replaces the products covered by an inventory hold placed on an ASN, addressed by its inventory_hold_uuid. The hold may have been created through this API or set up for you in the ShipMonk app.

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.
  • The same scope must not appear twice in one items list, and an item whose scope another hold on the same ASN already holds is rejected as well.
  • Just like creating a hold, this works only while the receiving's status is awaiting or arrived.
  • A hold that already ended, so its status is released or cancelled, cannot be changed any more.
  • A hold that covers every product of the receiving, shown in the list with sku: null, can only be released; its products can be changed only in the ShipMonk app.
post/v1/integrations/inventory-hold/update

Request

  • Base URL: https://api.shipmonk.com
  • URL: https://api.shipmonk.com/v1/integrations/inventory-hold/update
  • Auth: API key in header Api-Key

Request body

inventory_hold_uuidstring required

Identifier of the inventory hold to update, as returned when it was created or when the holds are listed.

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