* initialized next.js project * finished markdown sections * added operation schema component * change page metadata * eslint fixes * fixes related to deployment * added response schema * resolve max stack issue * support for different property types * added support for property types * added loading for components * added more loading * type fixes * added oneOf type * removed console * fix replace with push * refactored everything * use static content for description * fixes and improvements * added code examples section * fix path name * optimizations * fixed tag navigation * add support for admin and store references * general enhancements * optimizations and fixes * fixes and enhancements * added search bar * loading enhancements * added loading * added code blocks * added margin top * add empty response text * fixed oneOf parameters * added path and query parameters * general fixes * added base path env variable * small fix for arrays * enhancements * design enhancements * general enhancements * fix isRequired * added enum values * enhancements * general fixes * general fixes * changed oas generation script * additions to the introduction section * added copy button for code + other enhancements * fix response code block * fix metadata * formatted store introduction * move sidebar logic to Tags component * added test env variables * fix code block bug * added loading animation * added expand param + loading * enhance operation loading * made responsive + improvements * added loading provider * fixed loading * adjustments for small devices * added sidebar label for endpoints * added feedback component * fixed analytics * general fixes * listen to scroll for other headings * added sample env file * update api ref files + support new fields * fix for external docs link * added new sections * fix last item in sidebar not showing * move docs content to www/docs * change redirect url * revert change * resolve build errors * configure rewrites * changed to environment variable url * revert changing environment variable name * add environment variable for API path * fix links * fix tailwind settings * remove vercel file * reconfigured api route * move api page under api * fix page metadata * fix external link in navigation bar * update api spec * updated api specs * fixed google lint error * add max-height on request samples * add padding before loading * fix for one of name * fix undefined types * general fixes * remove response schema example * redesigned navigation bar * redesigned sidebar * fixed up paddings * added feedback component + report issue * fixed up typography, padding, and general styling * redesigned code blocks * optimization * added error timeout * fixes * added indexing with algolia + fixes * fix errors with algolia script * redesign operation sections * fix heading scroll * design fixes * fix padding * fix padding + scroll issues * fix scroll issues * improve scroll performance * fixes for safari * optimization and fixes * fixes to docs + details animation * padding fixes for code block * added tab animation * fixed incorrect link * added selection styling * fix lint errors * redesigned details component * added detailed feedback form * api reference fixes * fix tabs * upgrade + fixes * updated documentation links * optimizations to sidebar items * fix spacing in sidebar item * optimizations and fixes * fix endpoint path styling * remove margin * final fixes * change margin on small devices * generated OAS * fixes for mobile * added feedback modal * optimize dark mode button * fixed color mode useeffect * minimize dom size * use new style system * radius and spacing design system * design fixes * fix eslint errors * added meta files * change cron schedule * fix docusaurus configurations * added operating system to feedback data * change content directory name * fixes to contribution guidelines * revert renaming content * added api-reference to documentation workflow * fixes for search * added dark mode + fixes * oas fixes * handle bugs * added code examples for clients * changed tooltip text * change authentication to card * change page title based on selected section * redesigned mobile navbar * fix icon colors * fix key colors * fix medusa-js installation command * change external regex in algolia * change changeset * fix padding on mobile * fix hydration error * update depedencies
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.
|