Skip to main content

Update Receipt Line Quantity

PATCH 

/api/v2/warehouse-transfers/receipts/:receipt/lines/:line

Update a warehouse transfer receipt line's quantity. The shipment line and warehouse transfer line are NOT mutated by this edit — they remain canonical intent.

Required scope: warehouses:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Setting quantity to 0 removes the line: a quantity of 0 means the line was not received, so the receipt line, its inventory movement and its FIFO layer are removed and the units return to in transit at the destination (the receipt itself is kept). The preview reports this as removes_line: true. A receipt's only line cannot be removed this way - the request fails with 422 and blocks.last_line: true; delete the receipt instead.

Body fields:

  • quantity (required, integer ≥ 0) — new receipt line quantity
  • confirmed_implications (optional, boolean) — required when the preview reports requires_confirmation: true
  • redistribute_usages (optional, boolean) — required when reducing quantity causes FIFO usage redistribution

Returns 409 with the preview payload when confirmation is required and not yet provided.

Returns 422 with blocks.above_shipped: true when the new quantity exceeds the shipment line shipped quantity (minus other receipts), and blocks.above_transfer_line: true when it exceeds the warehouse transfer line quantity. The cap subtracts the totals of OTHER receipt lines on the same shipment line, so concurrent partial receipts each get their fair share.

Requires permission: warehouse_transfers.receive

Request​

Responses​

OK

Response Headers
    Content-Type