Preview Return Receipt Release Impact
POST/api/return-receipts/preview-release-impact
Read-only preview of which back-ordered sales orders this return receipt would release, per restock-to-sellable line. Send the same payload you would POST to create the receipt; each line that restocks sellable stock is resolved to its product and the receive warehouse and evaluated against waiting back-ordered demand. Nothing is written.
Each row describes one product the receive would restock. releasable_quantity is the number of incoming units that can be released to back-ordered demand; orders[] are the back-ordered sales orders that would be filled; held_back[] is demand that stays back-ordered, with reason_kept explaining why (e.g. "Insufficient supply").
Body: the same shape as Create Return Receipt. Minimum: warehouse_id and one return_receipt_lines entry with product_id, quantity, and action. release_backorders (true/false/null) mirrors the receive call's release control.
Authentication: Requires Bearer token. Requires the returns.receive permission.
Request
Responses
- 200
- 401
- 403
- 422
- 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.
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.