Skip to main content

Preview Receipt Line Quantity Change

GET 
/api/v2/warehouse-transfers/receipts/:receipt/lines/:line/quantity-preview

Preview the implications of changing a warehouse transfer receipt line quantity without persisting any changes.

Required scope: warehouses:read

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

Returns:

  • delta — change vs. current quantity
  • requires_confirmation — true if the user must confirm before saving
  • can_update — false when blocking conditions exist
  • blocks.above_shipped — true if the new quantity exceeds the parent shipment line's shipped quantity (minus other receipts against the same shipment line)
  • blocks.above_transfer_line — true if the new quantity exceeds the parent warehouse transfer line quantity (minus other receipts against the same shipment line)
  • caps.shipped_quantity — shipment line shipped quantity
  • caps.transfer_line_quantity — warehouse transfer line quantity
  • caps.other_receipts_total — total received on the same shipment line via other receipts (excluding the line being edited)
  • caps.max_quantity — minimum of shipped - other_receipts_total and transfer_line - other_receipts_total
  • implications.shipment_quantity — shipment line quantity is NOT mutated by a receipt edit
  • implications.transfer_quantity — warehouse transfer line quantity is NOT mutated by a receipt edit
  • implications.in_transit_quantity — recomputed in-transit at destination after edit
  • inventory — FIFO usage / redistribution preview (when decreasing)

Request​

Responses​

OK

Response Headers
    Content-Type