Sign in
Inventory Holds

Create Inventory Hold

Creates an inventory hold, which keeps the held units from being shipped.

General description

  • Currently every hold is placed on an Advance Shipping Notice (ASN): it covers products expected on the receiving and must be created before the receiving starts being received; afterwards the request is rejected. Other kinds of holds may become available later.
  • Each item holds one product, optionally narrowed down to a single lot number and/or expiration date.
  • A single ASN can carry several holds, each identified by the returned inventory_hold_uuid.
post/v1/integrations/inventory-hold

Request body

asnstring required

Advance Shipping Notice (ASN) number of the receiving the hold applies to. The receiving must not have started being received yet.

namestring required

Name of the inventory hold, shown in the ShipMonk app. Use it to tell your holds apart, e.g. by the reason for holding.

notestring nullable

Note explaining why the inventory is held. Visible in the ShipMonk app to both you and ShipMonk.

Example request

{
  "asn": "ASN-12345",
  "name": "Damaged pallet from supplier",
  "items": [
    {
      "lot": {
        "lot_number": "LOT-2025-001",
        "expiration_date": "2025-07-24"
      }
    }
  ]
}

Response

Success

inventory_hold_uuidstring required

Identifier of the created inventory hold. Use it to update or release the hold later.

Changes