Preview Shipment Line Quantity Change
GET/api/v2/warehouse-transfers/shipments/:shipment/lines/:line/quantity-preview
Preview the inventory implications of changing a warehouse transfer shipment line's quantity, without persisting any change.
warehouses:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Returns:
current_quantity,new_quantity,deltarequires_confirmation— true whenever delta != 0can_update— false when either block appliesblocks.below_received— true if the requested quantity is below the total already received against this line; adjust receipts firstblocks.above_transfer_line— true if the requested quantity exceeds the parent warehouse transfer line quantity (the WT line caps the shipment, not source on-hand stock)implications.shipment_quantity/transfer_quantity/received_quantity/in_transit_quantity— current vs after-update values. The parent warehouse transfer line quantity is ALWAYS unchanged (BBP invariant: the WT line is the canonical record of original intent).
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.