Preview Release Impact

POST 
/api/v2/inventory/movements/preview-release-impact

Dry-run preview: given a receipt payload, compute which pending backorder allocations would be released once the movement is committed.

Named route: v2.inventory.movements.preview-release-impact

When to call: UI should invoke this BEFORE committing a direction=receive movement so the operator can confirm how incoming stock will be consumed by existing backorders.

Request body: Same shape as the commit endpoint (see Commit Movement). Only direction, warehouse_id, movement_date, and lines[*].product_id + lines[*].quantity are required for preview.

Response shape:

{
  "data": {
    "total_units_receiving": 50,
    "total_allocations_released": 2,
    "releases": [ { fulfillment_id, product_id, quantity_released, ... } ],
    "held_back": [ ... ]
  }
}

Request

Responses

200

Successful response

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

422

Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.

429

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.