Preview Receipt Line Quantity
GET/api/inbound-shipment-receipts/:receipt/lines/:line/quantity-preview
Read-only preview of the effect of changing a receipt line's received quantity before saving. Returns how the change flows onto the inbound shipment line quantity and the purchase order line quantity (implications), the FIFO teardown/redistribution needed for a reduction (inventory), and - when the new quantity is LOWER than the current one - a demotion_impact list describing which order allocations the reduction would consume.
purchase-orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Each row is one product whose stock the action would consume. shortfall_quantity is how much more than available the action removes (stock goes negative when above zero). unallocated_quantity / soft_allocated_quantity / hard_allocated_quantity split the consumed quantity into free / soft-reserved / hard-allocated (label-printed) units. affected_allocations[] lists the order allocations consumed, highest priority first: allocation_type is soft or hard, and for hard rows fulfillment_id/carrier identify the label while carrier_void_supported and voidable_status say whether it can be voided through the API.
demotion_impact is empty for an increase or a no-op; only a reduction can strand an allocation. Use it to decide whether Update Receipt Line Quantity needs void_confirmations.
Query parameters:
quantity(integer, required) - the proposed new received quantity.
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
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.