Update Vendor Return
PUT/api/vendor-returns/:vendorReturn
Update a DRAFT vendor return. Returns that have been authorized, shipped, completed, or voided cannot be edited.
Authentication: Requires Bearer token.
Accepts the same fields as Create Vendor Return. On update, supplier_id, warehouse_id, and return_date are optional - omitted values keep their current value. When a lines array is provided it REPLACES the full existing line set; omit lines entirely to leave them unchanged.
The same validation invariants apply as on create: all lines must belong to a single purchase order, and per-line quantities cannot exceed the returnable (received minus already returned) quantity.
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.