Preview Bulk Remove Receipts Impact
POST/api/amazon/:integrationInstance/removal-shipments/bulk-remove-receipts/preview-impact
Read-only preview of the allocation-demotion impact of removing a batch of receipts by ID. Post the same receipt_ids you would send to the bulk remove-receipts call and it returns one row per affected product: how much of the removed quantity is unallocated vs soft-allocated vs hard-allocated, plus every sales-order allocation and fulfillment (printed shipping label) the removal would disturb. Use it to decide which fulfillments to authorize voiding via void_confirmations on the bulk remove-receipts call. Nothing is mutated. A removal that only re-adds free stock returns an empty data array.
Request body:
receipt_ids(array of integers, required, min 1) — the receipt (inventory-adjustment) IDs to preview removing.
Each row is one product the removal consumes stock for. shortfall_quantity is how much more than available the removal takes (stock goes negative if > 0); unallocated_quantity / soft_allocated_quantity / hard_allocated_quantity split the consumed quantity into free / soft-reserved / hard-allocated (label-printed). affected_allocations[] lists the consumed order allocations, highest priority first.
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.