Preview Vendor Return Ship Impact
GET/api/vendor-returns/:vendorReturn/ship-impact
Read-only preview of the allocation-demotion impact of shipping this vendor return. Shipping consumes the source stock reserved for the return, which can demote soft sales-order reservations to backorder and requires voiding printed shipping labels for any hard-allocated units. This returns the per-product rows describing exactly which order allocations would be affected, so the caller can collect the necessary void_confirmations before calling Ship Vendor Return.
Each row is one product whose stock the action would consume. shortfall_quantity is how much more than available the action removes (stock goes negative when above zero). unallocated_quantity / soft_allocated_quantity / hard_allocated_quantity split the consumed quantity into free / soft-reserved / hard-allocated (label-printed) units. affected_allocations[] lists the order allocations consumed, highest priority first: allocation_type is soft or hard, and for hard rows fulfillment_id/carrier identify the label while carrier_void_supported and voidable_status say whether it can be voided through the API.
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.