Sales Returns

Group: Inventory

Open in the interactive reference

A sales return records goods that a customer sends back.

A sales return is created as a draft. Committing it brings the goods back into stock and sets documentStatus to 'RECEIVED'. No other step of a return's workflow has an endpoint, and documentStatus can't be set directly.

Each line says what came back and where it goes. condition and disposition describe the goods. sourceDocumentLineId is the shipment line the goods went out on, from a line's id on GET inventory/shipments/:id. With it, the commit values the return at the original shipment cost.

A return is valued in the currency it was sold in, which can differ from the legal entity's functional currency.

Endpoints

• List sales returns: GET /inventory/sales-returns
• Create a sales return: POST /inventory/sales-returns
• Bulk create sales returns: POST /inventory/sales-returns/bulk
• Bulk delete sales returns: POST /inventory/sales-returns/bulk-delete
• Search sales returns: POST /inventory/sales-returns/search
• Retrieve a sales return: GET /inventory/sales-returns/{id}
• Update a sales return: PATCH /inventory/sales-returns/{id}
• Delete a sales return: DELETE /inventory/sales-returns/{id}
• Commit a sales return: POST /inventory/sales-returns/{id}/commit