bb87db8342
This PR includes documentation that preps for v2 docs (but doesn't introduce new docs). _Note: The number of file changes in the PR is due to find-and-replace within the `references` which is unavoidable. Let me know if I should move it to another PR._ ## Changes - Change Medusa version in base OAS used for v2. - Fix to docblock generator related to not catching all path parameters. - Added typedoc plugin that generates ER Diagrams, which will be used specifically for data model references in commerce modules. - Changed OAS tool to output references in `www/apps/api-reference/specs-v2` directory when the `--v2` option is used. - Added a version switcher to the API reference to switch between V1 and V2. This switcher is enabled by an environment variable, so it won't be visible/usable at the moment. - Upgraded docusaurus to v3.0.1 - Added new Vale rules to ensure correct spelling of Medusa Admin and module names. - Added new components to the `docs-ui` package that will be used in future documentation changes.
89 lines
4.5 KiB
Plaintext
89 lines
4.5 KiB
Plaintext
---
|
||
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 <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" /> or <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 next to the quantity of the item you want to edit.
|
||
3. To replace an item:
|
||
1. 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 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 <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 item.
|
||
2. Click on “Duplicate item” from the dropdown.
|
||
5. To delete an item:
|
||
1. 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 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. |