From 05357cc6e2fe935cba0867815e4b3b295b9f2c67 Mon Sep 17 00:00:00 2001 From: Benjamin Willems Date: Thu, 5 Apr 2018 17:00:54 -0700 Subject: [PATCH] Add stub article about Spree::Reimbursements --- guides/returns/reimbursements.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 guides/returns/reimbursements.md diff --git a/guides/returns/reimbursements.md b/guides/returns/reimbursements.md new file mode 100644 index 00000000000..c6014df47d1 --- /dev/null +++ b/guides/returns/reimbursements.md @@ -0,0 +1,28 @@ +# Reimbursements + + + +A `Spree::Reimbursement` represents your store's compensation to the customer +who is returning items. For example, if a customer is not happy with the quality +of your product and they decide to return it, your store may want to offer them +store credit for the price of the item. + +A `Spree::Reimbursement` can represent the reimbursement of one or many +`Spree::ReturnItem`s. However, if the return items have different +`Spree::ReimbursementType`s assigned, then multiple reimbursements are created +for a single customer return. + +Each `Spree:Reimbursement` object has the following attributes: + +- `number`: A unique eleven-character number that identifies the reimbursement. + The number starts with `RI`. For example: `RI123456789`. +- `reimbursement_status`: The status of the current reimbursement. +- `customer_return_id`: The ID for the `Spree::CustomerReturn` that is + associated with this reimbursement. +- `order_id`: The ID for the `Spree::Order` that is associated with the items on + the reimbursement. +- `total`: The total value of the reimbursement. Depending on the + `Spree::ReimbursementType`, this value may be `nil`. +