Vendor Returns

📄️List Vendor Returns

Paginated list of vendor returns, sorted by return date (newest first) by default. Archived returns are excluded unless filter[archived] is provided.

📄️Create Vendor Return

Create a draft vendor return for goods that will be physically sent back to a supplier.

📄️Get Vendor Return

Get a single vendor return with its lines, outbound shipments, and any vendor credits created from it.

📄️Update Vendor Return

Update a DRAFT vendor return. Returns that have been authorized, shipped, completed, or voided cannot be edited.

📄️Delete Vendor Return

Delete a DRAFT vendor return and its lines. Returns that have progressed past draft cannot be deleted - void them instead (Void Vendor Return), which reverses their postings while keeping an auditable record.

📄️Authorize Vendor Return

Authorize a DRAFT vendor return: locks it for editing and reserves the stock. A stock allocation is created for each product line so the goods awaiting return shipment cannot be sold or allocated elsewhere. Status moves from draft to authorized.

📄️Ship Vendor Return

Ship the vendor return: the goods physically leave the warehouse. Creates the outbound shipment record, posts the inventory-out movements, and posts the accounting for the return. Status moves from authorized to shipped. A DRAFT return is authorized automatically before shipping, so shipping is allowed from draft or authorized status.

📄️Complete Vendor Return

Mark a SHIPPED vendor return as completed - the supplier has acknowledged the return (typically once it is fully credited). Status moves from shipped to completed. No inventory or accounting changes are made.

📄️Void Vendor Return

Void a vendor return, reversing everything it posted:

📄️List Vendor Return Allocations

List the inventory allocations linked to this vendor return's lines - its Planned stock reservations plus any successor allocations they were promoted or demoted into. Paginated (10 per page by default). Each allocation carries its product, warehouse, quantity, status, hard-allocated flag, priority, and a `link_route` back to the source document.

📄️Get Vendor Return Activity Log

Paginated activity feed for this vendor return - its own status transitions plus events logged on its lines, shipments, and shipment lines, all rolled up onto the return. Newest first, 15 per page by default.

📄️Preview Vendor Return 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.

📄️Create Vendor Credit From Return

Create the financial vendor credit from a SHIPPED (or completed) vendor return - use this once the supplier's credit memo arrives. Returns the newly created draft vendor credit.

📄️List Returnable Lines For Purchase Order

For each line of a purchase order, report how much was received, how much has already been returned (across all non-void vendor returns, plus historical restock credits), and how much remains returnable. Use this before creating a vendor return to know which lines and quantities are still available to return.