Preview Removal Receive Release Impact
POST/api/amazon/:integrationInstance/removal-shipments/:removalShipment/receive/preview-release-impact
Read-only preview of which back-ordered sales orders receiving this removal shipment would release stock to, per sellable line. Post the proposed receipt payload (the same shape you would send to receive the shipment) and it returns one row per product: releasable_quantity units of incoming stock that can be released to back-ordered demand, the orders[] that would be filled, and held_back[] demand that stays back-ordered with reason_kept explaining why (e.g. "Insufficient supply"). Nothing is received or released.
Request body (proposed receipt):
receipt_date(string, required, date) — the receipt date.items(array, required, min 1) — one entry per received product line.items[].quantity_new(integer, required, >= 0) — resellable units received.items[].quantity_discarded(integer, required, >= 0) — damaged units discarded.items[].cogs_per_unit(number, required, >= 0) — landed cost per unit.items[].product_id(integer, required) — the product received.release_backorders(boolean, optional) —trueforce-releases waiting back-orders past the tenant auto-release gate,falsereceives as free stock, omitted honours the tenant gate.release_sales_order_ids(array of integers, optional) — restrict the release to specific sales orders.
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
Successful response
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.
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.
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.