docs: create docs workspace (#5174)
* 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
This commit is contained in:
Shahed Nasser
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"position": 3,
|
||||
"collapsed": false,
|
||||
"link": null,
|
||||
"label": "Orders",
|
||||
"customProps": {
|
||||
"sidebar_is_group_headline": true
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,174 @@
|
||||
---
|
||||
sidebar_position: 9
|
||||
description: 'This user guide explains how to manage order claims on the Medusa Admin. Learn how to create claims, manage their returns and fulfillments, and more.'
|
||||
addHowToData: true
|
||||
---
|
||||
|
||||
import UiIcon from '@site/src/components/UiIcon';
|
||||
|
||||
# Manage Order's Claims
|
||||
|
||||
In this document, you’ll learn what claims are, how to create them, and more.
|
||||
|
||||
## Overview
|
||||
|
||||
If a customer receives a faulty or incorrect item(s) for an order they placed, you can create a claim to either refund or replace the item(s).
|
||||
|
||||
When a claim is created, you can choose whether the claim will be resolved through a refund or by replacing the item(s).
|
||||
|
||||
---
|
||||
|
||||
## Create a Claim
|
||||
|
||||
:::caution
|
||||
|
||||
If you create a claim of type Refund, a refund is issued to the customer right after the claim is created. Before you can create a claim for an order, you must capture the order’s payment, and create fulfillment in the order for the items included in the claim.
|
||||
|
||||
:::
|
||||
|
||||
:::info
|
||||
|
||||
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).
|
||||
|
||||
:::
|
||||
|
||||
1. Open the order 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 at the top right.
|
||||
3. Click on Register Claim in the dropdown.
|
||||
4. In the new window that opens:
|
||||
- Choose the items you want to create the claim for. For each item you pick, you must select the reason for the claim:
|
||||
- Click on the Select Reason button below the item.
|
||||
- Choose the Reason from the options in the Reason field.
|
||||
- Optionally add a Note or upload images as part of the reason.
|
||||
- Click on the Add button.
|
||||
- Choose the Shipping method to use to return the item.
|
||||
- You can add a custom price for the shipping method by clicking on the Add custom price button.
|
||||
- You can remove the custom price by clicking on 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 next to the price.
|
||||
- For the Location field, you can optionally choose the location that the items should be returned to.
|
||||
- Choose whether the type of the claim is “Refund” or “Replace”. If you choose “Replace”:
|
||||
- Choose the products you want to send to the customer by clicking Add Product and choosing the product you want to add.
|
||||
- You can remove a product from the “items to send” list by clicking on 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.
|
||||
- If you want to send the items to another address, click on “Ship to a different address” and fill out the shipping address info.
|
||||
- Choose the Shipping Method that will be used to deliver the replacement items.
|
||||
- If you don’t want the customer to receive an email that a claim has been created, uncheck the “Send notifications” checkbox.
|
||||
5. Once you’re done, click on the Complete button.
|
||||
|
||||
---
|
||||
|
||||
## View Claim Details
|
||||
|
||||
To view an order’s claim details:
|
||||
|
||||
1. Open the order details page.
|
||||
2. In the Timeline section, find the claim and 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 at its right.
|
||||
3. Click on More Details in the dropdown.
|
||||
|
||||
---
|
||||
|
||||
## Manage a Claim’s Returns
|
||||
|
||||
### Receive a Claim’s Return
|
||||
|
||||
To mark a claim’s return as received:
|
||||
|
||||
1. Open the order details page.
|
||||
2. In the Timeline section, find the return requested.
|
||||
3. Click on the Receive Return button.
|
||||
4. Check or uncheck the items that have been received.
|
||||
5. Click the Complete button.
|
||||
|
||||
### Cancel a Claim’s Return
|
||||
|
||||
:::caution
|
||||
|
||||
Canceling a return can’t be undone.
|
||||
|
||||
:::
|
||||
|
||||
To cancel a return of a claim:
|
||||
|
||||
1. Open the order details page.
|
||||
2. In the Timeline section, find the return requested and 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 “Cancel return” in the dropdown.
|
||||
|
||||
---
|
||||
|
||||
## Manage a Claim’s Fulfillments
|
||||
|
||||
:::caution
|
||||
|
||||
This section only applies if the Claim’s type is Replace.
|
||||
|
||||
:::
|
||||
|
||||
### Create a Fulfillment for a Claim
|
||||
|
||||
You can create fulfillment for items in the claim that you are sending to the customer as a replacement. You can create more than one fulfillment, with each having at least one item.
|
||||
|
||||
To create a fulfillment for a claim:
|
||||
|
||||
1. Open the order details page.
|
||||
2. In the Timeline section, find the claim and 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 Fulfill Claim in the dropdown.
|
||||
4. In the window that opens:
|
||||
- Choose the items you want to fulfill. You can change the quantity of the items you’re fulfilling 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.
|
||||
- Optionally add under Metadata any additional information that might be necessary for the fulfillment.
|
||||
- If you don’t want the customer to receive an email that a fulfillment for the claim items has been created, uncheck the “Send notifications” checkbox.
|
||||
5. Once you’re done, click on the Complete button.
|
||||
|
||||
### Mark a Claim’s Fulfillment Shipped
|
||||
|
||||
To mark a claim’s fulfillment as shipped:
|
||||
|
||||
1. Open the order details page.
|
||||
2. Scroll down to the Fulfillment section.
|
||||
3. Find the fulfillment you want to mark as shipped. A claim’s fulfillment’s title should be prefixed with “Claim fulfillment”.
|
||||
4. 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.
|
||||
5. Click on Mark Shipped in the dropdown.
|
||||
6. In the new window that opens:
|
||||
- Enter a tracking number for the shipment.
|
||||
- If you have more than one tracking number, click on the “Add Additional Tracking Number” to add more numbers.
|
||||
- If you don’t want the customer to receive an email that the fulfillment has been shipped, uncheck the “Send notifications” checkbox.
|
||||
7. Once you’re done, click the Complete button.
|
||||
|
||||
Shipment details can be seen in the Timeline section.
|
||||
|
||||
### Cancel a Claim’s Fulfillment
|
||||
|
||||
:::caution
|
||||
|
||||
If you cancel a fulfillment, it can’t be reverted. Only a fulfillment that hasn’t been marked as shipped can be canceled.
|
||||
|
||||
:::
|
||||
|
||||
To cancel a claim’s fulfillment:
|
||||
|
||||
1. Open the order details page.
|
||||
2. Scroll down to the Fulfillment section.
|
||||
3. Find the fulfillment you want to cancel. A claim’s fulfillment’s title should be prefixed with “Claim fulfillment”.
|
||||
4. 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.
|
||||
5. Click on Cancel Fulfillment in the dropdown.
|
||||
6. Confirm canceling the fulfillment by clicking the “Yes, confirm” button in the pop-up.
|
||||
|
||||
---
|
||||
|
||||
## Cancel a Claim
|
||||
|
||||
### For Refund Claims
|
||||
|
||||
A claim of type Refund can be canceled by just [canceling the return of the claim](#cancel-a-claims-return). However, the refund can not be reverted.
|
||||
|
||||
### For Replace Claims
|
||||
|
||||
:::caution
|
||||
|
||||
Canceling a claim can’t be undone. The [return of the claim must be canceled](#cancel-a-claims-return) before the claim itself is canceled.
|
||||
|
||||
:::
|
||||
|
||||
To cancel a claim of type Replace:
|
||||
|
||||
1. Open the order details page.
|
||||
2. In the Timeline section, find the claim and 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 Cancel Claim in the dropdown.
|
||||
4. Confirm canceling the fulfillment by clicking the “Yes, remove” button in the pop-up.
|
||||
@@ -0,0 +1,130 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
description: 'This user guide explains how to manage draft orders on the Medusa Admin. Learn how to create a draft order, view its details, edit a draft order, cancel a draft order, and more.'
|
||||
addHowToData: true
|
||||
---
|
||||
|
||||
import UiIcon from '@site/src/components/UiIcon';
|
||||
|
||||
# Manage Draft Orders
|
||||
|
||||
In this document, you’ll learn more about draft orders, how to create them, and more.
|
||||
|
||||
## Overview
|
||||
|
||||
Draft orders are orders created from the Medusa admin. Existing products or custom items can be added to the order as purchased items. You can also specify custom shipping amounts.
|
||||
|
||||
After a draft order is created and is marked as paid, an order will be created based on that draft order and it will appear as part of the Orders list.
|
||||
|
||||
---
|
||||
|
||||
## Create a Draft Order
|
||||
|
||||
To create a draft order:
|
||||
|
||||
1. Go to Orders → Drafts.
|
||||
2. Click on “Create draft order” at the top right.
|
||||
3. A new window then opens with six steps to go through to create the draft order:
|
||||
1. In the first step, choose the region this draft order belongs to, then click the Next button.
|
||||
2. In the second step, add items to the order. You must add at least one item. Once you’re done, click the Next button.
|
||||
1. To add existing products:
|
||||
1. Click on the Add Existing button.
|
||||
2. Choose the products you want to add into the draft order by clicking the checkbox at the left of the product. You can choose more than one product.
|
||||
3. Once done, click on the Add button.
|
||||
2. To add a custom item:
|
||||
1. Click on the Add Custom button.
|
||||
2. Enter the title, price, and quantity of the custom item.
|
||||
3. Click on the Add button.
|
||||
3. To remove an item you added, click on 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 at the right of the item.
|
||||
4. To change the quantity of any item, use 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 under the Quantity column.
|
||||
5. Once you’re done, click the Next button.
|
||||
3. In the third step, choose a shipping method then click the Next button.
|
||||
1. If you want to change the default price of the shipping method, click on the “Set custom price” button and enter the price you want to use.
|
||||
2. If you want to remove the custom price, you can click on 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. In the fourth step, enter the customer’s details and shipping address.
|
||||
1. If the customer already exists, you can choose it from the "Find existing customer" input. You can search the list of customers by name or email. This fills out the fields under the General section as well.
|
||||
2. If this is a new customer, in the "Email" field, enter the email of the customer to add. Then, fill out the customer’s first name, last name, and phone number in the General section.
|
||||
3. In the Shipping Address section, enter the customer’s address details such as the Address line, postal code, and more.
|
||||
4. Once you’re done, click on the Next button.
|
||||
5. In the fifth step, specify the billing address details.
|
||||
1. If the billing address is the same as the shipping address, you can just check the “Use same as shipping” checkbox.
|
||||
2. If the billing address is different than the shipping address, fill out the information under the General and Billing Address as instructed in the previous step.
|
||||
3. Once done, click the Next button.
|
||||
6. In the last step, confirm that all the information is correct.
|
||||
1. If you want to add a discount, click on the Add Discount button and enter the discount code.
|
||||
2. If you want to edit any of the draft order’s info, click on the Edit link next to any of the sections. This will take you back to the step associated with that section.
|
||||
4. Once you’re done following all the six steps, click on the Submit button.
|
||||
|
||||
---
|
||||
|
||||
## Open Draft Order’s Details
|
||||
|
||||
To open a draft order’s details page:
|
||||
|
||||
1. Go to Orders → Drafts.
|
||||
2. Select the draft order you want to view.
|
||||
|
||||
---
|
||||
|
||||
## Edit Draft Order Info
|
||||
|
||||
### Edit Shipping Address
|
||||
|
||||
To edit the shipping address of a draft order:
|
||||
|
||||
1. Open the draft order details page.
|
||||
2. Scroll down to the customer section and 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 in that section.
|
||||
3. Click on Edit Shipping Address in the dropdown.
|
||||
4. This opens a new window to edit the shipping address’s info.
|
||||
5. Once you’re done click on the "Save and close" button.
|
||||
|
||||
---
|
||||
|
||||
## Cancel Draft Order
|
||||
|
||||
:::warning
|
||||
|
||||
Canceling a draft order cannot be undone and the draft order will be removed from the list of draft orders.
|
||||
|
||||
:::
|
||||
|
||||
To cancel a draft order:
|
||||
|
||||
1. Open the draft order details page.
|
||||
2. 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 at the top right of the first section.
|
||||
3. Click on Cancel Draft Order in the dropdown.
|
||||
4. Confirm canceling the draft order by clicking the “Yes, remove” button in the pop-up.
|
||||
|
||||
---
|
||||
|
||||
## Mark Draft Order as Paid
|
||||
|
||||
:::caution
|
||||
|
||||
When you mark a draft order as paid, a new order is created and associated with this draft order. This can’t be undone, but the new order created can be canceled.
|
||||
|
||||
:::
|
||||
|
||||
To mark a draft order as paid:
|
||||
|
||||
1. Open the draft order details page.
|
||||
2. Scroll down to the Payment section.
|
||||
3. Click on the “Mark as paid” button.
|
||||
4. Confirm your action by clicking the “Mark paid” button in the pop-up.
|
||||
|
||||
You should see a new order in the Orders list now.
|
||||
|
||||
---
|
||||
|
||||
## Go to Associated Order
|
||||
|
||||
:::info
|
||||
|
||||
This is only available after a draft order is marked as paid.
|
||||
|
||||
:::
|
||||
|
||||
To go to the order associated with the draft order.
|
||||
|
||||
1. Open the draft order details page.
|
||||
2. Click on the “Go to Order” button at the top right of the first section.
|
||||
@@ -0,0 +1,89 @@
|
||||
---
|
||||
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.
|
||||
@@ -0,0 +1,81 @@
|
||||
---
|
||||
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.
|
||||
@@ -0,0 +1,66 @@
|
||||
---
|
||||
sidebar_position: 10
|
||||
description: 'This user guide explains how to export a list of orders on the Medusa admin.'
|
||||
addHowToData: true
|
||||
---
|
||||
|
||||
import UiIcon from '@site/src/components/UiIcon';
|
||||
|
||||
# Export Orders
|
||||
|
||||
In this document, you’ll learn how to export all orders in your Medusa store.
|
||||
|
||||
## Overview
|
||||
|
||||
When you export your orders, you can obtain a list of your orders and their details in a CSV file. This can be useful if you want to migrate from one Medusa backend to another, or if you need the CSV file for other purposes.
|
||||
|
||||
---
|
||||
|
||||
## Export List of Orders
|
||||
|
||||
To export orders:
|
||||
|
||||
1. Go to Orders page.
|
||||
2. Click on Export Orders at the top right.
|
||||
3. Click Export in the window that opens.
|
||||
4. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999016/Medusa%20Docs/UI%20Icons/mWhpxNX_xteuos.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999044/Medusa%20Docs/UI%20Icons/tE8LOXk_puyrib.png" alt="bell" /> icon at the top right of the page.
|
||||
5. You should see your new export loading.
|
||||
6. Once the export is ready, click on the Download button.
|
||||
|
||||
:::note
|
||||
|
||||
If you face any errors or difficulties, please contact your technical support team as this could be an issue in the storage integration used.
|
||||
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
## Cancel an Order Export
|
||||
|
||||
:::info
|
||||
|
||||
You can only cancel an unfinished order export.
|
||||
|
||||
:::
|
||||
|
||||
To cancel an order export:
|
||||
|
||||
1. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999016/Medusa%20Docs/UI%20Icons/mWhpxNX_xteuos.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999044/Medusa%20Docs/UI%20Icons/tE8LOXk_puyrib.png" alt="bell" /> icon at the top right of the page.
|
||||
2. Find the export you want to cancel.
|
||||
3. Click on the cancel button.
|
||||
|
||||
---
|
||||
|
||||
## Delete an Order Export
|
||||
|
||||
:::info
|
||||
|
||||
You can only delete a finished order export.
|
||||
|
||||
:::
|
||||
|
||||
To delete an order export:
|
||||
|
||||
1. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999016/Medusa%20Docs/UI%20Icons/mWhpxNX_xteuos.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999044/Medusa%20Docs/UI%20Icons/tE8LOXk_puyrib.png" alt="bell" /> icon at the top right of the page.
|
||||
2. Find the export you want to delete.
|
||||
3. Click on the Delete button.
|
||||
@@ -0,0 +1,86 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
sidebar_label: Manage Fulfillments
|
||||
description: 'This user guide explains how to manage order fulfillments in the Medusa Admin. Learn how to create fulfillments, mark fulfillments as shipped, and cancel fulfillments.'
|
||||
addHowToData: true
|
||||
---
|
||||
|
||||
import UiIcon from '@site/src/components/UiIcon';
|
||||
|
||||
# Manage Order's Fulfillments
|
||||
|
||||
In this tutorial, you’ll learn about order fulfillments and how to manage them, including how to create fulfillments and mark them as shipped.
|
||||
|
||||
## Overview
|
||||
|
||||
When a customer places an order, the fulfillment status of the order will be “not_shipped”. You can then create fulfillments and mark them as shipped once you ship the items.
|
||||
|
||||
You can create more than one fulfillment, with each fulfillment used for at least one item in the order.
|
||||
|
||||
If some items of the order are fulfilled, the order’s fulfillment status will be “partially_shipped”. Once all items are shipped, the order’s fulfillment status will be “shipped”.
|
||||
|
||||
---
|
||||
|
||||
## Create Fulfillment
|
||||
|
||||
:::info
|
||||
|
||||
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 a fulfillment for an order:
|
||||
|
||||
1. Open the order details page.
|
||||
2. Scroll down to the Fulfillment section.
|
||||
3. Click on the Create Fulfillment button.
|
||||
4. In the window that opens:
|
||||
- Choose the location you want to fulfill the items from.
|
||||
- Under Items to fulfill, enter the quantity of the items you want to fulfill.
|
||||
- Optionally enter any additional information you want to associate with the fulfillment under the Metadata section.
|
||||
- If you don’t want the customer to receive an email that a fulfillment has been created, uncheck the “Send notifications” checkbox.
|
||||
5. Once done, click on the "Create fulfillment" button.
|
||||
|
||||
You can check the fulfillment details in the Fulfillment and Timeline sections.
|
||||
|
||||
---
|
||||
|
||||
## Mark a Fulfillment Shipped
|
||||
|
||||
:::caution
|
||||
|
||||
Once a fulfillment is marked as shipped, it can’t be reverted. You must [create a fulfillment](#create-fulfillment) first before you can mark it as shipped.
|
||||
|
||||
:::
|
||||
|
||||
To mark a fulfillment as shipped in an order:
|
||||
|
||||
1. Open the order details page.
|
||||
2. Scroll down to the Fulfillment section.
|
||||
3. Find the fulfillment you want to mark as shipped, then 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 Mark Shipped in the dropdown.
|
||||
5. In the new window that opens:
|
||||
- Enter a tracking number for the shipment.
|
||||
- If you have more than one tracking number, click on the “Add Additional Tracking Number” to add more numbers.
|
||||
- If you don’t want the customer to receive an email that the fulfillment has been shipped, uncheck the “Send notifications” checkbox.
|
||||
6. Once you’re done, click the Complete button.
|
||||
|
||||
Shipment details can be seen in the Timeline section.
|
||||
|
||||
---
|
||||
|
||||
## Cancel a Fulfillment
|
||||
|
||||
:::caution
|
||||
|
||||
If you cancel a fulfillment, it can’t be reverted. Only a fulfillment that hasn’t been marked as shipped can be canceled.
|
||||
|
||||
:::
|
||||
|
||||
To cancel a fulfillment in an order:
|
||||
|
||||
1. Open the order details page.
|
||||
2. Scroll down to the Fulfillment section.
|
||||
3. Find the fulfillment you want to cancel, then 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 Fulfillment in the dropdown.
|
||||
5. Confirm canceling the fulfillment by clicking the “Yes, confirm” button in the pop-up.
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
sidebar_label: Overview
|
||||
description: 'Medusa Admin allows merchants to manage orders. Merchants can view order information, capture payment, create shipments and fulfillments, and more.'
|
||||
---
|
||||
|
||||
# Orders Overview
|
||||
|
||||
In this document, you’ll get an overview of the orders listing page and everything you can do with it.
|
||||
|
||||
## Overview
|
||||
|
||||
When customers buy one or more products, their order appears on the Orders page. You can view an order’s information, capture payment, create shipments and fulfillments, register returns or exchanges of the order, and more.
|
||||
|
||||
The Orders domain also contains draft orders. Draft orders are orders that you create from the Medusa admin. After you fill out the order and mark it paid, it’s transformed into an order that appears as part of the Orders list.
|
||||
|
||||
---
|
||||
|
||||
## View List of Orders
|
||||
|
||||
You can view the list of available orders in your ecommerce store by clicking on Orders from the sidebar menu.
|
||||
|
||||
In the list, you can see order details such as the ID, date, customer, fulfillment and payment status, total, and the country of the shipping address.
|
||||
|
||||
---
|
||||
|
||||
## View List of Draft Orders
|
||||
|
||||
You can view the list of draft orders on the Orders page by clicking on the grey Drafts headline next to the Orders headline.
|
||||
|
||||
In the list, you can see order details such as ID, the ID of the order the draft order belongs to, the date, the customer, and the status of the draft order.
|
||||
|
||||
---
|
||||
|
||||
## Learn More About Orders
|
||||
|
||||
- [Manage Order Details](./manage.mdx)
|
||||
- [Manage Order’s Payment](./payments.md)
|
||||
- [Manage Order’s Fulfillment](./fulfillments.mdx)
|
||||
- [Manage Draft Orders](./drafts.mdx)
|
||||
- [Manage Order Returns](./returns.mdx)
|
||||
- [Manage Order Claims](./claims.mdx)
|
||||
- [Manage Order Exchanges](./exchange.mdx)
|
||||
- [Export Orders](./export.mdx)
|
||||
@@ -0,0 +1,198 @@
|
||||
---
|
||||
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.
|
||||
@@ -0,0 +1,55 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
sidebar_label: Manage Payments
|
||||
addHowToData: true
|
||||
---
|
||||
|
||||
# Manage Order's Payments
|
||||
|
||||
In this document, you’ll learn how to manage an order’s payment, including capturing and refunding the payment.
|
||||
|
||||
## Overview
|
||||
|
||||
When a customer places an order, using the payment provider they choose during checkout, they authorize the payment.
|
||||
|
||||
The payment isn’t automatically captured. You must capture it manually from the Medusa admin.
|
||||
|
||||
---
|
||||
|
||||
## Capture Payment
|
||||
|
||||
:::info
|
||||
|
||||
Payment can only be captured once.
|
||||
|
||||
:::
|
||||
|
||||
To capture an order’s payment:
|
||||
|
||||
1. Open the order details page.
|
||||
2. Scroll to the Payment section.
|
||||
3. Click on the Capture Payment button.
|
||||
|
||||
---
|
||||
|
||||
## Refund Payment
|
||||
|
||||
:::caution
|
||||
|
||||
Refunding payments can’t be undone. Payment can only be refunded after it has been captured.
|
||||
|
||||
:::
|
||||
|
||||
To refund an order’s payment:
|
||||
|
||||
1. Open the order details page.
|
||||
2. Scroll to the Payment section.
|
||||
3. Click on the Refund button.
|
||||
4. In the new window that opens:
|
||||
- Enter the Refund amount. It must be less than the Total Paid amount specified in the Payment section.
|
||||
- In the Reason field, choose a reason for the refund.
|
||||
- For the Note field, you can optionally provide a note for the customer to see.
|
||||
- If you don’t want the customer to receive an email that the refund has been made, uncheck the “Send notifications” checkbox.
|
||||
5. Once you’re done, click on the Complete button.
|
||||
|
||||
You can check refund details in the Payment, Summary, and Timeline sections.
|
||||
@@ -0,0 +1,92 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
sidebar_label: Manage Returns
|
||||
description: 'This user guide explains how to manage order returns on the Medusa Admin. Learn how to request a return for an order, mark a return as received, and cancel a return.'
|
||||
addHowToData: true
|
||||
---
|
||||
|
||||
import UiIcon from '@site/src/components/UiIcon';
|
||||
|
||||
# Manage Order’s Returns
|
||||
|
||||
In this document, you’ll learn more about order returns, how to request a return, and more.
|
||||
|
||||
## Overview
|
||||
|
||||
Part of the order management system that Medusa provides is automating and managing order returns.
|
||||
|
||||
There are two ways of returns for an order to be requested:
|
||||
|
||||
1. The customer requests a return for an order through the storefront, which the store operator can view on the admin.
|
||||
2. The store operator requests to receive a return from the customer. The customer can be informed about this through an email.
|
||||
|
||||
After a return is requested, the store operator can choose to either cancel the return or mark it as received. When a return is marked as received, a refund is issued to the customer.
|
||||
|
||||
---
|
||||
|
||||
## Find Return Requests of an Order
|
||||
|
||||
To find return requests of an order:
|
||||
|
||||
1. Open the order details page.
|
||||
2. On the Timeline section, you’ll find any returns requested, whether by store operators or by customers.
|
||||
|
||||
---
|
||||
|
||||
## Request a Return for an Order
|
||||
|
||||
:::info
|
||||
|
||||
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 request a return for an order:
|
||||
|
||||
1. Open the order 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 at the top right.
|
||||
3. Click on Request Return in the dropdown.
|
||||
4. In the new window that opens:
|
||||
- Choose the items in the order that you want to request the return.
|
||||
- For each item that you choose, click on the Select Reason below that item.
|
||||
- Choose a [Return Reason](../settings/return-reasons.mdx#add-return-reason), optionally enter a Note, then click the Add button.
|
||||
- For the Location field, you can optionally choose the location you want these items to be returned to.
|
||||
- Select a shipping method you want to use for this return.
|
||||
- If you want to change the default price of the shipping method, click on the “Add custom price” button and enter the price you want to use.
|
||||
- If you want to remove the custom price, you can click on 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.
|
||||
- If you don’t want the customer to receive an email that a return has been requested, uncheck the “Send notifications” checkbox.
|
||||
5. Once done, click on the Submit button.
|
||||
|
||||
---
|
||||
|
||||
## Receive Return
|
||||
|
||||
:::caution
|
||||
|
||||
Once the return is marked as received, a refund will be issued to the customer. A return can only be marked as “received” if the payment of the order or the items chosen in the return is captured.
|
||||
|
||||
:::
|
||||
|
||||
To mark a return as received:
|
||||
|
||||
1. Open the order details page.
|
||||
2. In the Timeline section, find the return requested.
|
||||
3. Click on the Receive Return button.
|
||||
4. Check or uncheck the items that have been received.
|
||||
5. Click the Complete button.
|
||||
|
||||
---
|
||||
|
||||
## Cancel a Return
|
||||
|
||||
:::danger
|
||||
|
||||
If a return is canceled it can’t be undone. A return can only be canceled if it hasn’t been marked as received.
|
||||
|
||||
:::
|
||||
|
||||
To cancel a return:
|
||||
|
||||
1. Open the order details page.
|
||||
2. In the Timeline section, find the return requested and 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 “Cancel return” in the dropdown.
|
||||
Reference in New Issue
Block a user