Inventory Holds

Release Inventory Hold

Changed on

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

General description

  • Unlike creating and updating a hold, releasing works in any receiving status, also once receiving has started.
  • A hold that is still awaiting_review (created in the ShipMonk app and not yet approved by ShipMonk) 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

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

Request body

inventory_hold_uuidstring required

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

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