-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add stub article about Spree::Reimbursements
- Loading branch information
1 parent
f3eed45
commit 05357cc
Showing
1 changed file
with
28 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# Reimbursements | ||
|
||
<!-- TODO: | ||
This article is a stub. | ||
--> | ||
|
||
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`. | ||
|