From 3767cf26f7e912cfa94713b7127cb1dccd2755f0 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Tue, 13 Sep 2022 18:30:48 +0300 Subject: [PATCH] docs: added returns user guide (#2199) --- docs/content/user-guide/orders/drafts.mdx | 2 +- .../user-guide/orders/fulfillments.mdx | 4 +- docs/content/user-guide/orders/index.md | 2 +- docs/content/user-guide/orders/payments.md | 2 +- docs/content/user-guide/orders/returns.md | 11 --- docs/content/user-guide/orders/returns.mdx | 83 +++++++++++++++++++ 6 files changed, 88 insertions(+), 16 deletions(-) delete mode 100644 docs/content/user-guide/orders/returns.md create mode 100644 docs/content/user-guide/orders/returns.mdx diff --git a/docs/content/user-guide/orders/drafts.mdx b/docs/content/user-guide/orders/drafts.mdx index ff3c3099f4..7ddcb1bea4 100644 --- a/docs/content/user-guide/orders/drafts.mdx +++ b/docs/content/user-guide/orders/drafts.mdx @@ -99,7 +99,7 @@ To cancel a draft order: :::caution -💡 When you mark a draft order as paid, a new order is created and associated with this draft order. This can’t be undone, but the new order created can be canceled. +When you mark a draft order as paid, a new order is created and associated with this draft order. This can’t be undone, but the new order created can be canceled. ::: diff --git a/docs/content/user-guide/orders/fulfillments.mdx b/docs/content/user-guide/orders/fulfillments.mdx index a960376887..11df68cee3 100644 --- a/docs/content/user-guide/orders/fulfillments.mdx +++ b/docs/content/user-guide/orders/fulfillments.mdx @@ -46,7 +46,7 @@ You can check the fulfillment details in the Fulfillment and Timeline sections. :::caution -You must [create a fulfillment](#create-fulfillment) first before you can mark it as shipped. Once a fulfillment is marked as shipped, it can’t be reverted. +Once a fulfillment is marked as shipped, it can’t be reverted. You must [create a fulfillment](#create-fulfillment) first before you can mark it as shipped. ::: @@ -70,7 +70,7 @@ Shipment details can be seen in the Timeline section. :::caution -Only a fulfillment that hasn’t been marked as shipped can be canceled. If you cancel a fulfillment, it can’t be reverted. +If you cancel a fulfillment, it can’t be reverted. Only a fulfillment that hasn’t been marked as shipped can be canceled. ::: diff --git a/docs/content/user-guide/orders/index.md b/docs/content/user-guide/orders/index.md index f6b79b13cb..c8ef233753 100644 --- a/docs/content/user-guide/orders/index.md +++ b/docs/content/user-guide/orders/index.md @@ -37,6 +37,6 @@ In the list, you can see order details such as ID, the ID of the order the draft - [Manage Order’s Payment](./payments.md) - [Manage Order’s Fulfillment](./fulfillments.mdx) - [Manage Draft Orders](./drafts.mdx) -- [Manage Order Returns](./returns.md) +- [Manage Order Returns](./returns.mdx) - [Manage Order Claims](./claims.md) - [Manage Order Exchanges and Swaps](./swaps.md) diff --git a/docs/content/user-guide/orders/payments.md b/docs/content/user-guide/orders/payments.md index 55acbb2af8..542dcd1b97 100644 --- a/docs/content/user-guide/orders/payments.md +++ b/docs/content/user-guide/orders/payments.md @@ -35,7 +35,7 @@ To capture an order’s payment: :::caution -Payment can only be refunded after it has been captured. Refunding payments can’t be undone. +Refunding payments can’t be undone. Payment can only be refunded after it has been captured. ::: diff --git a/docs/content/user-guide/orders/returns.md b/docs/content/user-guide/orders/returns.md deleted file mode 100644 index 77b997dd52..0000000000 --- a/docs/content/user-guide/orders/returns.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Manage Returns - -:::note - -This guide is coming soon. - -::: diff --git a/docs/content/user-guide/orders/returns.mdx b/docs/content/user-guide/orders/returns.mdx new file mode 100644 index 0000000000..af8fb68ff9 --- /dev/null +++ b/docs/content/user-guide/orders/returns.mdx @@ -0,0 +1,83 @@ +--- +sidebar_position: 6 +sidebar_label: Manage Returns +--- + +import UiIcon from '@site/src/components/UiIcon'; + +# Manage Order’s Returns + +In this document, you’ll learn more about order returns, how to request a return, and more. + +## Overview + +Part of the order management system that Medusa provides is automating and managing order returns. + +There are two ways of returns for an order to be requested: + +1. The customer requests a return for an order through the storefront, which the store operator can view on the admin. +2. The store operator requests to receive a return from the customer. The customer can be informed about this through an email. + +After a return is requested, the store operator can choose to either cancel the return or mark it as received. When a return is marked as received, a refund is issued to the customer. + +--- + +## Find Return Requests of an Order + +To find return requests of an order: + +1. Open the order details page. +2. On the Timeline section, you’ll find any returns requested, whether by store operators or by customers. + +--- + +## Request a Return for an Order + +To request a return for an order: + +1. Open the order details page. +2. In the Timeline section, click on the icon at the top right. +3. Click on Request Return in the dropdown. +4. In the new window that opens: + - Choose the items in the order that you want to request the return. + - For each item that you choose, click on the Select Reason below that item. + - Choose a Return Reason, optionally enter a Note, then click the Add button. + - Select a shipping method you want to use for this return. + - If you want to change the default price of the shipping method, click on the “Add custom price” button and enter the price you want to use. + - If you want to remove the custom price, you can click on the icon. + - If you don’t want the customer to receive an email that a return has been requested, uncheck the “Send notifications” checkbox. +5. Once done, click on the Submit button. + +--- + +## Receive Return + +:::caution + +Once the return is marked as received, a refund will be issued to the customer. A return can only be marked as “received” if the payment of the order or the items chosen in the return is captured. + +::: + +To mark a return as received: + +1. Open the order details page. +2. In the Timeline section, find the return requested. +3. Click on the Receive Return button. +4. Check or uncheck the items that have been received. +5. Click the Complete button. + +--- + +## Cancel a Return + +:::danger + +If a return is canceled it can’t be undone. A return can only be canceled if it hasn’t been marked as received. + +::: + +To cancel a return: + +1. Open the order details page. +2. In the Timeline section, find the return requested and click on the icon. +3. Click on “Cancel return” in the dropdown.