Skip to main content

Release Inventory Hold

POST 
/api/v2/inventory/holds/:reservation/release

Releases inventory from a hold. Supports both partial and full release.

Partial release (quantity provided AND less than current held quantity):

  • The hold's quantity is reduced by the released amount
  • released_quantity accumulates the cumulative total released across all release events
  • released_at remains null — the hold is still active

Full release (quantity omitted, null, 0, or equal to current held quantity):

  • released_at, released_by, and release_reason are populated
  • The remaining quantity is added to released_quantity so it reflects the cumulative total released

Authentication: Requires Bearer token.

Request Body:

  • quantity (nullable, numeric, min 0.0001, max=current held quantity): Quantity to release. Omit, send null, or send 0 to fully release. Cannot exceed the current held quantity (returns 422)
  • release_reason (nullable, string, max 500): Reason for the release

Request​

Responses​

Successful response