* 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
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.
|