Skip to main content

Create Inventory Hold

POST 
/api/v2/inventory/holds

Creates a single inventory hold (reservation) for a product in a specific warehouse. Deducts from available inventory.

Authentication: Requires Bearer token.

Request Body:

  • product_id (required, integer): Product to hold
  • warehouse_id (required, integer): Warehouse where inventory is held
  • quantity (required, numeric, min 0.0001): Quantity to hold
  • reason (required, string, max 255): Reason for the hold
  • notes (optional, string): Additional notes
  • expires_at (optional, date, must be future): Expiration date for the hold

Request​

Responses​

Successful response