Purchase Returns

Group: Inventory

Open in the interactive reference

A purchase return sends goods you received back to the vendor, for example because they were damaged, wrong, or more than you ordered. It is the opposite of a sales return.

A purchase return records goods you received that you send back to the vendor. Each line takes a quantity of one item out of one warehouse. A line can name the receipt line or the purchase order line it draws on: the line the goods were originally received or ordered on. The returned quantity counts against what is still returnable on that line. You can create a purchase return from scratch, or from a purchase order with POST inventory/purchase-returns/from-purchase-order.

A purchase return goes through these steps:

• It is created with the documentStatus 'DRAFT'. Stock does not change.
• Approving it sets 'APPROVED'. Stock does not change.
• Shipping it sets 'COMMITTED'. The stock leaves the warehouse, the returned quantity is recorded on the receipt lines, and a journal entry is created in the general ledger. Shipping a purchase return does not create a shipment.
• Canceling it sets 'CANCELLED' and puts the stock back in the warehouse.

The statuses 'PREPARED', 'SHIPPED', 'VENDOR_ACKNOWLEDGED', 'CREDITED', and 'COMPLETED' are set in the application.

A purchase return does not create batches or serial numbers. A line for a batch-tracked or serialized item names the batches or serialized units that already exist. Purchase returns do not check a batch's batchStatus, qcStatus, or temperatureBreach.

Endpoints

• List purchase returns: GET /inventory/purchase-returns
• Create a purchase return: POST /inventory/purchase-returns
• Bulk create purchase returns: POST /inventory/purchase-returns/bulk
• Bulk delete purchase returns: POST /inventory/purchase-returns/bulk-delete
• Draft a purchase order return: POST /inventory/purchase-returns/from-purchase-order
• Search purchase returns: POST /inventory/purchase-returns/search
• Retrieve a purchase return: GET /inventory/purchase-returns/{id}
• Update a purchase return: PATCH /inventory/purchase-returns/{id}
• Delete a purchase return: DELETE /inventory/purchase-returns/{id}
• Approve a purchase return: POST /inventory/purchase-returns/{id}/approve
• Cancel a purchase return: POST /inventory/purchase-returns/{id}/cancel
• Ship a purchase return: POST /inventory/purchase-returns/{id}/ship