Void Vendor Return
POST/api/vendor-returns/:vendorReturn/void
Void a vendor return, reversing everything it posted:
- shipped inventory movements are reversed (stock is put back)
- reserved stock from authorization is released
- the return's accounting entries are removed
- per-line clearing/accounts-payable quantities are cleared
Status moves to void. Voiding an already-void return succeeds and returns it unchanged.
Authentication: Requires Bearer token.
Blocked with 422 when any vendor credit line references the return - remove those credit lines first.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
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.