fa7c94b4cc
* 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
199 lines
8.3 KiB
Plaintext
199 lines
8.3 KiB
Plaintext
---
|
||
sidebar_position: 2
|
||
sidebar_label: Manage Details
|
||
description: 'Learn in this user guide how to manage orders on the Medusa Admin. Learn how to find the order details page, what information can be found on that page, and how to manage the order details such as shipping address or email.'
|
||
addHowToData: true
|
||
---
|
||
|
||
import UiIcon from '@site/src/components/UiIcon';
|
||
|
||
# Manage Order Details
|
||
|
||
In this document, you’ll learn how to find an order’s details page, what information you can find on the order details page, and how to manage some of the order’s details.
|
||
|
||
## Open Order’s Details
|
||
|
||
To open an order’s details:
|
||
|
||
1. Go to Orders.
|
||
2. Select one of the orders.
|
||
|
||
This opens the order’s details page.
|
||
|
||
---
|
||
|
||
## Sections of the Order Details Page
|
||
|
||
### Order Summary
|
||
|
||
The first section of the page shows the summary of the order, including its current status, date created, email, and payment method.
|
||
|
||
### Timeline
|
||
|
||
This section of the order details page shows a summary of the order’s history. This includes updates to the order’s status, requests for return or exchange, notes, and more.
|
||
|
||
### Summary
|
||
|
||
This section includes the summary of the items the customer purchased as well as totals related to taxes, shipping, and more.
|
||
|
||
### Payment
|
||
|
||
This section includes details related to the order’s payments and allows you to capture the authorized payment.
|
||
|
||
### Fulfillment
|
||
|
||
This section includes details related to the shipping method and fulfillment and allows you to create fulfillment.
|
||
|
||
### Customer
|
||
|
||
This section includes the customer’s details, including their shipping address.
|
||
|
||
---
|
||
|
||
## Manage Item Allocation
|
||
|
||
:::note
|
||
|
||
This feature is only available if you have the Inventory and Stock Locations module installed. You can learn more in the [Multi-Warehouse documentation](../multiwarehouse/index.md).
|
||
|
||
:::
|
||
|
||
Item allocation occurs when a customer places an order. The ordered quantity of the items is considered reserved of the underlying product variant's quantity in a stock location. This is only applied for product variants that have "Manage Inventory" enabled.
|
||
|
||
You can manage the item's allocation by managing the location that the item's quantity will be reserved from.
|
||
|
||
### Allocate an Item
|
||
|
||
Items should be allocated by default. However, in some edge cases the item may need to be allocated manually.
|
||
|
||
To allocate an Item:
|
||
|
||
1. Go to the order details page.
|
||
2. Scroll to the Summary section.
|
||
3. You should see an "Awaits allocation" badge at the top of the Summary section. Click on it.
|
||
4. In the form that opens:
|
||
1. For the Location field, choose the location to allocate the item from.
|
||
2. In the Items to Allocate section, choose the quantity to allocate for each item.
|
||
5. Once you're done, click the "Save allocation" button.
|
||
|
||
### Edit Item Allocation
|
||
|
||
If an item is already allocated, you can edit its allocation by following these steps:
|
||
|
||
1. Go to the order details page.
|
||
2. Scroll to the Summary section.
|
||
3. Find the item you want to change its allocation. If the item is already allocated, you should see a <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1680265348/Medusa%20Docs/UI%20Icons/check-circle-solid-lightpng_yvyrz0.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1680265348/Medusa%20Docs/UI%20Icons/check-circle-solid-dark_eo8dgm.png" alt="check" /> icon next to it.
|
||
4. Hover over the icon, then click the "Edit Allocation" button.
|
||
5. In the new window that opens:
|
||
1. In the Locations field, choose the location to allocate this item from.
|
||
2. Once done, click the "Save and close" button.
|
||
|
||
### Delete Item Allocation
|
||
|
||
To delete an item allocation:
|
||
|
||
1. Go to the order details page.
|
||
2. Scroll to the Summary section.
|
||
3. Find the item you want to delete its allocation. If the item is already allocated, you should see a check icon next to it.
|
||
4. Hover over the icon, then click the "Edit Allocation" button.
|
||
5. In the new window that opens, click on the "Delete allocation" button.
|
||
|
||
---
|
||
|
||
## Edit the Shipping Address
|
||
|
||
To edit the shipping address used for an order:
|
||
|
||
1. Open the order details page.
|
||
2. Scroll down to the Customer section.
|
||
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.
|
||
4. Click on Edit Shipping Address from the dropdown.
|
||
5. This opens a new window to edit the shipping address.
|
||
6. Once you’re done, click on the Save button.
|
||
|
||
---
|
||
|
||
## 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 <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.
|
||
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:
|
||
|
||
1. Open the order details page.
|
||
2. Scroll down to the Customer section.
|
||
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.
|
||
4. Click on Edit Email Address from the dropdown.
|
||
5. This opens a new window to edit the email address.
|
||
6. Once you’re done, click on the Save button.
|
||
|
||
---
|
||
|
||
## 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 <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.
|
||
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:
|
||
|
||
1. Open the order details page.
|
||
2. In the Timeline section, enter the note in the text input. You can also choose emojis by clicking the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999389/Medusa%20Docs/UI%20Icons/UwA7Ljp_mlt58a.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999407/Medusa%20Docs/UI%20Icons/9lcr16b_e5gcqz.png" alt="emoji" /> icon.
|
||
3. Once done, click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999420/Medusa%20Docs/UI%20Icons/hH4pKe3_ltdg5o.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999435/Medusa%20Docs/UI%20Icons/QlvPezL_zsyikc.png" alt="send" /> icon.
|
||
|
||
The note will be added and can be seen in the timeline.
|
||
|
||
---
|
||
|
||
## Delete a Note
|
||
|
||
:::caution
|
||
|
||
Deleted notes can’t be retrieved.
|
||
|
||
:::
|
||
|
||
To delete a note in an order:
|
||
|
||
1. Open the order details page.
|
||
2. In the Timeline section, find the note you want to delete from the timeline.
|
||
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 the note.
|
||
4. Click on Delete from the dropdown.
|
||
5. Confirm deleting the note by clicking the “Yes, delete” button in the pop-up.
|
||
|
||
---
|
||
|
||
## Cancel an Order
|
||
|
||
:::warning
|
||
|
||
Once an order is canceled it can’t be undone.
|
||
|
||
:::
|
||
|
||
To cancel an order:
|
||
|
||
1. Open the order details page.
|
||
2. In the first section showing the order’s number, 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" /> at the top right.
|
||
3. Click on Cancel Order from the dropdown.
|
||
4. Confirm canceling the order by clicking the “Yes, confirm” button in the pop-up.
|