Records items on a fulfillment as returned: refunded, so they won't be sent. Use it when part of an order is refunded before it ships.
Each returned_items row adds to returned_quantity on the fulfillment's lines. When you send return_line_id (the line on the refund sale), Smooth POS first fills the fulfillment line for the original sale line that refund line is linked to. Anything left over is spread over the item's other lines in line order.
Afterwards Smooth POS works out the fulfillment's status from its lines. A fulfillment is complete when every line has actual_quantity + returned_quantity of at least requested_quantity.
| Fulfillment | Complete | Not complete |
|---|---|---|
| Warehouse To Warehouse or Warehouse To Customer | Closed | In Progress |
| Store Pickup | Awaiting Pickup if anything was shipped, otherwise Closed | In Progress |
Inactive, Closed and Canceled fulfillments keep their status (the lines are still recorded). A fulfillment at Integrated Refund that still isn't complete stays at Integrated Refund. Shipping or returning never sets Integrated Refund: only Mark a fulfillment as Integrated Refund does.
The response, and the fulfillment_return system hook, include fulfillment_status and fulfillment. When the status changes, fulfillment_status_change fires too.
Required permission:
| Group | Permission |
|---|---|
| Fulfilment & Shipping | Create, edit, pick, ship and return fulfilments |