Preview Vendor Credit Ship Impact
GET/api/vendor-credits/:vendor_credit/ship-impact
Get a read-only preview of the order allocations that creating a return shipment for this vendor credit's restock lines would consume. Each row is one product whose stock the shipment would remove, split into free, soft-reserved and hard-allocated quantities, and lists the affected sales-order allocations highest-priority first so you can see which orders — and which printed shipping labels — would be demoted or voided before you post the shipment.
This endpoint makes no changes.
Response fields:
data[].product_id/product_sku/product_name— the product the action would consume stock for.data[].shortfall_quantity— how much more than the available quantity the action removes; stock goes negative when greater than 0.data[].unallocated_quantity/soft_allocated_quantity/hard_allocated_quantity— the free / soft-reserved / hard-allocated (label-printed) split of the consumed quantity.data[].affected_allocations[]— the order allocations that would be consumed, highest priority first.allocation_typeissoftorhard. For hard rows,fulfillment_idandcarrieridentify the printed label andcarrier_void_supported/voidable_status(voidableor otherwise) indicate whether the label can be voided through the API.
Authentication: Requires Bearer token (PAT).
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.