Sign in
Inventory Holds

Release Inventory Hold

Releases the whole inventory hold, so the held units can be shipped again.

General description

  • Unlike creating and updating a hold, releasing works at any time, also once the receiving has started.
  • A hold that is still awaiting ShipMonk review ends cancelled instead of released; the response message tells which of the two happened.
  • The call is idempotent, so releasing an already released hold succeeds and changes nothing.
post/v1/integrations/inventory-hold/release

Request body

inventory_hold_uuidstring required

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

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