* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
82 lines
5.4 KiB
Plaintext
82 lines
5.4 KiB
Plaintext
---
|
||
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
|
||
---
|
||
|
||
import UiIcon from '@site/src/components/UiIcon';
|
||
|
||
# Manage Exchanges
|
||
|
||
In this document, you’ll learn how to manage order exchanges including how to find customers’ requested order exchanges, how to create them, and how to fulfill them.
|
||
|
||
## Find Requested Order Exchanges
|
||
|
||
To find customers’ requested order exchanges:
|
||
|
||
1. Go to an order’s details page.
|
||
2. In the Timeline section, if there are any requested exchanges you’ll find them with the title “Exchange Requested”.
|
||
|
||
## Create an Order Exchange
|
||
|
||
:::info
|
||
|
||
- An exchange can only be created if the order’s payment is captured and the items have been fulfilled.
|
||
- The steps mentioned here regarding an item's location and quantity are only available if you have the Inventory and Stock Location modules installed. You can learn more in the [Multi-Warehouse documentation](../multiwarehouse/index.md).
|
||
|
||
:::
|
||
|
||
To create an order exchange:
|
||
|
||
1. Go to an order’s details page.
|
||
2. In the Timeline section, click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon.
|
||
3. Click on Register Exchange from the dropdown.
|
||
4. In the new window that opens:
|
||
1. Choose the items you want the customer to return. For each item you select:
|
||
1. Click on the Select Reason button.
|
||
2. Choose a reason from available Reasons. If you can’t find any Reasons, make sure to add [Return Reasons in Settings](../settings/return-reasons.mdx#add-return-reason) first.
|
||
3. You can optionally add a Note.
|
||
4. Once you’re done, click on the Add button.
|
||
2. Choose a Shipping Method to return the customer’s items.
|
||
1. You can optionally specify a custom price for shipping by clicking the “Add custom price” button.
|
||
2. You can remove the custom price by clicking the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999273/Medusa%20Docs/UI%20Icons/7hztVhj_mj6mxu.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999290/Medusa%20Docs/UI%20Icons/1yp4PNt_vzwnhf.png" alt="trash" /> icon.
|
||
3. For the Location field, you can optionally choose the location that the items should be returned to.
|
||
4. In the “Items to send” section, click on the Add Product button. Then:
|
||
1. Check the products you want to send to the customer in exchange.
|
||
2. When you’re done, click the Add button.
|
||
3. You can remove products you’ve added by clicking the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999273/Medusa%20Docs/UI%20Icons/7hztVhj_mj6mxu.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999290/Medusa%20Docs/UI%20Icons/1yp4PNt_vzwnhf.png" alt="trash" /> icon.
|
||
4. You can change the quantity of the product to send using the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999131/Medusa%20Docs/UI%20Icons/1hL8NiW_lqmjcq.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999150/Medusa%20Docs/UI%20Icons/8LtkPqW_jyqz5i.png" alt="plus" /> and <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999351/Medusa%20Docs/UI%20Icons/EGk9uYD_a7rwhs.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999366/Medusa%20Docs/UI%20Icons/XvkBK8p_dzhzfx.png" alt="minus" /> icons.
|
||
5. If you don’t want the customer to receive an email that an exchange has been registered, uncheck the “Send notifications” checkbox.
|
||
5. Once you’re done, click the Complete button.
|
||
|
||
## Mark an Exchange’s Return as Received
|
||
|
||
To mark a return that is part of an exchange as received:
|
||
|
||
1. Go to an order’s details page.
|
||
2. In the Timeline section, find the order exchange.
|
||
3. Click on the Receive Return button.
|
||
4. Check the items you want to mark as received.
|
||
5. Click the Complete button.
|
||
|
||
## Cancel an Exchange
|
||
|
||
:::warning
|
||
|
||
Canceling an exchange can’t be undone.
|
||
|
||
:::
|
||
|
||
The return of an exchange must be canceled first before the exchange itself can be canceled. If the return has been marked as received, the exchange can’t be canceled after that.
|
||
|
||
To cancel an exchange:
|
||
|
||
1. Go to an order’s details page.
|
||
2. In the Timeline section, find the order exchange.
|
||
3. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon next to it.
|
||
4. Click on “Cancel return” from the dropdown.
|
||
5. Confirm canceling the return by clicking the “Yes, cancel” button in the pop-up.
|
||
6. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon again next to the order exchange.
|
||
7. Click on “Cancel exchange” from the dropdown.
|
||
8. Confirm canceling the exchange by clicking the “Yes, cancel” button in the pop-up.
|