From a65e115844494bf0944afa64386dc93ef4d74fd6 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Thu, 26 Jan 2023 19:30:17 +0200 Subject: [PATCH] docs: added user guide for order editing (#3120) --- docs/content/user-guide/orders/claims.mdx | 2 +- docs/content/user-guide/orders/drafts.mdx | 2 +- docs/content/user-guide/orders/edit.mdx | 89 +++++++++++++++++++++ docs/content/user-guide/orders/exchange.mdx | 2 +- docs/content/user-guide/orders/export.mdx | 2 +- docs/content/user-guide/orders/manage.mdx | 26 ++++++ docs/content/user-guide/orders/payments.md | 3 +- docs/content/user-guide/orders/returns.mdx | 2 +- 8 files changed, 122 insertions(+), 6 deletions(-) create mode 100644 docs/content/user-guide/orders/edit.mdx diff --git a/docs/content/user-guide/orders/claims.mdx b/docs/content/user-guide/orders/claims.mdx index a5a4514404e9..842b9eb02aac 100644 --- a/docs/content/user-guide/orders/claims.mdx +++ b/docs/content/user-guide/orders/claims.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 8 +sidebar_position: 9 description: 'This user guide explains how to manage order claims on the Medusa Admin. Learn how to create claims, manage their returns and fulfillments, and more.' addHowToData: true --- diff --git a/docs/content/user-guide/orders/drafts.mdx b/docs/content/user-guide/orders/drafts.mdx index ddcde29fb44f..8ee9e71405f9 100644 --- a/docs/content/user-guide/orders/drafts.mdx +++ b/docs/content/user-guide/orders/drafts.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 5 +sidebar_position: 6 description: 'This user guide explains how to manage draft orders on the Medusa Admin. Learn how to create a draft order, view its details, edit a draft order, cancel a draft order, and more.' addHowToData: true --- diff --git a/docs/content/user-guide/orders/edit.mdx b/docs/content/user-guide/orders/edit.mdx new file mode 100644 index 000000000000..5a33ddbd352f --- /dev/null +++ b/docs/content/user-guide/orders/edit.mdx @@ -0,0 +1,89 @@ +--- +sidebar_position: 5 +description: 'This user guide explains how to edit the items in an order in the Medusa admin. You can add, update, replace, duplicate, and delete items.' +addHowToData: true +--- + +import UiIcon from '@site/src/components/UiIcon'; + +# Edit an Order’s Items + +In this document, you’ll learn how to edit items in an order. This includes adding, updating, or deleting items. + +## Overview + +Using the Medusa Admin, you can edit the items in an order. You can perform the following edits: + +- Add a new item to the order. +- Edit the quantity of an existing item in the order. +- Delete an item from the order. + +When you request an order edit, the changes aren’t actually saved and reflected on the order until the order edit is confirmed. + +There are two ways to confirm an order edit request: + +1. The customer reviews the order edit. If they accept the order edit and an additional payment is required, then they’ll have to authorize that payment. The customer can also reject the order edit; +2. Or you force-confirm the order edit. In this case, the order edit is reflected on the original order. If there are any additional payment required, you would have to handle that manually with the customer. + +--- + +## Request an Order Edit + +:::info + +You can’t request an order edit if another order edit is already requested. + +::: + +To request an order edit: + +1. Open the order details page. +2. Click on the “Edit Order” button at the top right of the Summary section. +3. In the new window that opens: + 1. To add an item: + 1. Click on the “Add items” button. + 2. Click on the checkbox next to the items you want to add. + 3. Once done, click on the “Save and go back” button. + 2. To update an item’s quantity: + 1. Click on the or icons next to the quantity of the item you want to edit. + 3. To replace an item: + 1. Click on the icon next to the item. + 2. Click on “Replace with other item” from the dropdown. + 3. Choose the replacement by clicking on the radio button next to the new item. + 4. Once done, click on the “Save and go back” button. + 4. To duplicate an item: + 1. Click on the icon next to the item. + 2. Click on “Duplicate item” from the dropdown. + 5. To delete an item: + 1. Click on the icon next to the item. + 2. Click on “Remove item” from the dropdown. + 6. You can optionally enter a note for the customer to see in the Note field. +4. Once done, click on the “Save and close” button. + +--- + +## Force Confirm an Order + +:::warning + +When you force confirm an order edit, the changes will be reflected on the order. If the order edit requires additional payment, you’ll have to manually receive that payment from the customer. + +::: + +To force confirm an order: + +1. Open the order details page. +2. Find the order edit in the Timeline section. +3. Click on the “Force Confirm” button. +4. Confirm your action by clicking the “Yes, Force Confirm” button in the pop-up. + +--- + +## Cancel an Order Edit Request + +To cancel an order-edit request: + +1. Open the order details page. +2. Find the order edit in the Timeline section. +3. Click on the “Cancel Order Edit” button. +4. Click the button again to confirm canceling the order. \ No newline at end of file diff --git a/docs/content/user-guide/orders/exchange.mdx b/docs/content/user-guide/orders/exchange.mdx index 8c280f83b1d4..04c28c5f895e 100644 --- a/docs/content/user-guide/orders/exchange.mdx +++ b/docs/content/user-guide/orders/exchange.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 7 +sidebar_position: 8 description: 'This user guide explains how to manage exchanges in the Medusa Admin. Learn how to create an order exchange, create an order exchange, mark an order exchange return as received, and cancel an exchange.' addHowToData: true --- diff --git a/docs/content/user-guide/orders/export.mdx b/docs/content/user-guide/orders/export.mdx index 7e1d2d5972b6..d70965427cae 100644 --- a/docs/content/user-guide/orders/export.mdx +++ b/docs/content/user-guide/orders/export.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 9 +sidebar_position: 10 description: 'This user guide explains how to export a list of orders on the Medusa admin.' addHowToData: true --- diff --git a/docs/content/user-guide/orders/manage.mdx b/docs/content/user-guide/orders/manage.mdx index 7677025bd132..32b0b0fc9187 100644 --- a/docs/content/user-guide/orders/manage.mdx +++ b/docs/content/user-guide/orders/manage.mdx @@ -63,6 +63,19 @@ To edit the shipping address used for an order: --- +## Edit the Billing Address + +To edit the billing address used for an order: + +1. Open the order details page. +2. Scroll down to the Customer section. +3. Click on the icon. +4. Click on Edit Billing Address from the dropdown. +5. This opens a new window to edit the billing address. +6. Once you’re done, click on the Save button. + +--- + ## Edit Email Address To edit the email address associated with an order: @@ -76,6 +89,19 @@ To edit the email address associated with an order: --- +## Transfer Customer Ownership + +To change the customer that placed this order: + +1. Open the order details page. +2. Scroll down to the Customer section. +3. Click on the icon. +4. Click on "Transfer ownership" from the dropdown. +5. In the new window that opens choose the new customer to own this order. +6. Once done, click on the Confirm button. + +--- + ## Add a Note To add a note to an order: diff --git a/docs/content/user-guide/orders/payments.md b/docs/content/user-guide/orders/payments.md index 6b9ce852b338..a518eed97f27 100644 --- a/docs/content/user-guide/orders/payments.md +++ b/docs/content/user-guide/orders/payments.md @@ -47,7 +47,8 @@ To refund an order’s payment: 3. Click on the Refund button. 4. In the new window that opens: - Enter the Refund amount. It must be less than the Total Paid amount specified in the Payment section. - - Choose a reason for the refund and optionally provide a note. + - Choose a reason for the refund. + - Optionally provide a note for the customer to see. - If you don’t want the customer to receive an email that the refund has been made, uncheck the “Send notifications” checkbox. 5. Once you’re done, click on the Complete button. diff --git a/docs/content/user-guide/orders/returns.mdx b/docs/content/user-guide/orders/returns.mdx index 0c32c0d67fbf..cada6cfe4aab 100644 --- a/docs/content/user-guide/orders/returns.mdx +++ b/docs/content/user-guide/orders/returns.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 6 +sidebar_position: 7 sidebar_label: Manage Returns description: 'This user guide explains how to manage order returns on the Medusa Admin. Learn how to request a return for an order, mark a return as received, and cancel a return.' addHowToData: true