Skip to main content

Preview Demotion Impact

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

Dry-run preview: given an outbound/adjust-down payload, compute which allocations (unallocated, soft-allocated, hard-allocated) would be consumed, and whether any hard-allocated fulfillments will require an explicit void confirmation before commit.

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

When to call: UI should invoke this BEFORE committing direction=ship or direction=adjust_down to surface any allocations that would be demoted, including hard-allocated fulfillments whose shipping labels may need to be voided.

Key response field: requires_void_confirmation (bool) — when true, the caller MUST include a matching void_confirmations[] entry in the commit payload for every hard-allocated fulfillment listed in lines[*].buckets.hard_allocated.fulfillments.

Response shape:

{
  "data": {
    "requires_void_confirmation": true,
    "lines": [
      {
        "product_id": 123,
        "product_sku": "SKU-ABC",
        "product_name": "Widget",
        "quantity_requested": 10,
        "buckets": {
          "unallocated": { quantity, ... },
          "soft_allocated": { quantity, fulfillments: [...] },
          "hard_allocated": { quantity, fulfillments: [ { fulfillment_id, provider, ... } ] }
        }
      }
    ]
  }
}

Request​

Responses​

Successful response