Skip to content

Docs: Update readme #204

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
filafb wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Docs: Update readme #204

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,20 @@ The custom Return Reasons can be translated manually by the admin.
- **Proportional shipping value**: the shipping value to be refunded per item will be automatically calculated based on the item value percentage of the total order value.
- **Item condition selector**: require the store user to select the condition of the items

#### Request statuses

| Status | Label | Description | Next status |
| ---- | ---- | ---- | ---- |
| `New` | `new` | Initial status for all requests | `Processing`<br><br>`Denied`<br><br>`Cancelled` |
| `Processing` | `processing` | Store acknowledges the request | `Picked up from client`<br><br>`Denied`<br><br>`Cancelled` - only by admin users |
| `Picked up from client` | `pickedUpFromClient` | Store receives the returned products or a status from a courier notifying the request was picked up | `Pending verification`<br><br> `Denied` |
| `Pending verification` | `pendingVerification` | Store checks the products returned by the customer. The "Verify package" button will be available on the return details page. If done via the API the action to update to the next status requires a payload containing the items to be refunded information. If there is no item, the request will be `denined` automatically | `Package Verified`<br><br>`Denied` |
| `Package Verified` | `packageVerified` | Store accepts all items returned | `Amount refunded` |
| `Amount refunded` | `amountRefunded` | This is the last state for a return request, if it has not been denied. The administrators will move the request in this state after making the payment to the client (by card or by bank transfer) - which can de automatically made by the app depending on the settings configured in the admin side. If the customer requested the return of the money by voucher, the voucher will be generated automatically when the request reach this state. | `-` |
| `Denied` | `denied` | The return request reaches this state by an admin user action. Items included in the request will not be avaiable to be returned in another request | `-` |
| `Cancelled` | `cancelled` | An admin user can cancel a request up to the `processing` status. The store user can cancel a request only when the return status is `new`. The items included on that request will be available to be returned in another one | `-` |


### Transactional Emails
The app leverages the capabilites of VTEX Message Center to notify the customers when a return request is created and when the status of their return changes.

Expand Down