chore: reorganize docs apps (#7228)
* reorganize docs apps * add README * fix directory * add condition for old docs
This commit is contained in:
1 parent
224ebb2154
commit
4fe28f5a95
6187 files changed
+601447
-598226
No files matched your search
@@ -0,0 +1,202 @@
|
||||
---
|
||||
sidebar_position: 8
|
||||
---
|
||||
|
||||
import {
|
||||
EllipsisHorizontal,
|
||||
} from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Order's Claims`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll learn what claims are, how to create them, and more.
|
||||
|
||||
## Overview
|
||||
|
||||
If a customer receives a faulty or incorrect items for an order, you can create a claim to either refund or replace the item(s).
|
||||
|
||||
---
|
||||
|
||||
## Create a Claim
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
If the claim has a refund amount, the refund is issued to the customer right after the claim is created.
|
||||
|
||||
</Note>
|
||||
|
||||
<Note type="check">
|
||||
|
||||
You must capture the order’s payment and create fulfillment in the order for the items included in the claim first.
|
||||
|
||||
</Note>
|
||||
|
||||
{/* TODO check steps for correctness */}
|
||||
|
||||
1. Open the order details page.
|
||||
2. In the Timeline section, click on the <InlineIcon Icon={EllipsisHorizontal} alt="three dots" /> icon at the top right.
|
||||
3. Choose "Register claim" from the dropdown.
|
||||
4. In the new form that opens, there are two steps:
|
||||
1. In the first step, choose the items to claim, then click the Continue button.2
|
||||
2. In the second step:
|
||||
1. For each item under the "Items to claim" section, enter the quantity, choose the return reason, and optionally enter a note that the customer can view.
|
||||
2. Under the "Shipping for claimed items" section:
|
||||
1. Choose the location to return the items to.
|
||||
2. Choose the shipping method used to return the items.
|
||||
3. Under the "Items to Replace" section:
|
||||
1. To add items, click on the "Add items" button, choose products from the drawer, then click the "Add products" button.
|
||||
2. To change the quantity sent of an item, change the value under its Quantity column.
|
||||
4. If you chose items to replace in the previous section, a "Shipping for replacement items section is shown".
|
||||
- Choose the shipping method used to send the item to the customer. Note that its price is considered `0` as the customer isn't expected to pay for it.
|
||||
5. If there's an amount to be refunded, change that amount by toggling the "Custom refund" button and entering the new refund amount in the field shown.
|
||||
6. To disable sending a notification to the customer about the created claim, toggle the "Send notifications" button.
|
||||
5. Once you’re done, click on the Save button.
|
||||
|
||||
---
|
||||
|
||||
## View Claim Details
|
||||
|
||||
{/* TODO check steps for correctness */}
|
||||
|
||||
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 <InlineIcon Icon={EllipsisHorizontal} alt="three dots" /> icon at its right.
|
||||
3. Click on More Details in the dropdown.
|
||||
|
||||
---
|
||||
|
||||
## Manage a Claim’s Returns
|
||||
|
||||
{/* TODO check steps for correctness */}
|
||||
|
||||
### 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
|
||||
|
||||
{/* TODO check steps for correctness */}
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Canceling a return is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
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 <InlineIcon Icon={EllipsisHorizontal} alt="three dots" /> icon.
|
||||
3. Click on “Cancel return” in the dropdown.
|
||||
|
||||
---
|
||||
|
||||
## Manage a Claim’s Fulfillments
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
This section only applies if the claim has replacement items.
|
||||
|
||||
</Note>
|
||||
|
||||
### Create a Fulfillment for a Claim
|
||||
|
||||
{/* TODO check steps for correctness */}
|
||||
|
||||
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 <InlineIcon Icon={EllipsisHorizontal} alt="three dots" /> icon.
|
||||
3. Click on Fulfill Claim in the dropdown.
|
||||
4. In the form that opens:
|
||||
- Choose the items you want to fulfill. You can change the quantity of the items you’re fulfilling using the plus and 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 a notification 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
|
||||
|
||||
{/* TODO check steps for correctness */}
|
||||
|
||||
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 <InlineIcon Icon={EllipsisHorizontal} alt="three dots" /> icon next to it.
|
||||
5. Click on Mark Shipped in the dropdown.
|
||||
6. In the new form 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 a notification 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
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Canceling a fulfillment is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
<Note type="check">
|
||||
|
||||
Only a fulfillment that hasn’t been marked as shipped can be canceled.
|
||||
|
||||
</Note>
|
||||
|
||||
{/* TODO check steps for correctness */}
|
||||
|
||||
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 <InlineIcon Icon={EllipsisHorizontal} 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
|
||||
|
||||
{/* TODO check info for correctness */}
|
||||
|
||||
### 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
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Canceling a claim is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
<Note type="check">
|
||||
|
||||
The [return of the claim must be canceled](#cancel-a-claims-return) before the claim itself is canceled.
|
||||
|
||||
</Note>
|
||||
|
||||
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 <InlineIcon Icon={EllipsisHorizontal} 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,139 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
---
|
||||
|
||||
import {
|
||||
EllipsisHorizontal,
|
||||
} from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Draft Orders`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll learn more about draft orders, how to create them, and more.
|
||||
|
||||
## Overview
|
||||
|
||||
Draft orders are orders created by an admin user. Products or custom items are 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 is created based on that draft order and it appears as part of the Orders list.
|
||||
|
||||
---
|
||||
|
||||
## Create a Draft Order
|
||||
|
||||
To create a draft order:
|
||||
|
||||
{/* TODO check steps after #3 */}
|
||||
|
||||
1. Go to Orders → Draft Orders.
|
||||
2. Click on Create button at the top right.
|
||||
3. A new window opens with two steps to create the draft order:
|
||||
1. In the first step:
|
||||
1. Under the Region section, choose the region this draft order belongs to.
|
||||
2. Under the Existing Items section, you can add existing products to the draft order. To do that:
|
||||
1. Click on the "Add products" button.
|
||||
2. In the drawer that opens, choose the products you want to add into the draft order by clicking the checkbox at the left of the product.
|
||||
3. Once done, click on the "Add products" button.
|
||||
3. Under the Custom Items section, you can add custom items to the draft order. To do that:
|
||||
1. In the table, enter the item's title, quantity, and price.
|
||||
2. To add another item, press the <Kbd>tab</Kbd> key, then enter that item's details in the new row.
|
||||
3. Once done, click on the "Add custom item" button.
|
||||
4. Under the Shipping section:
|
||||
1. Choose the shipping method of the draft order.
|
||||
2. To optionally change the price of the chosen shipping method, enter the price in the "Custom shipping price" field.
|
||||
5. Under the Customer section, enter the customer's details:
|
||||
1. If the customer exists, choose it from the "Find existing customer" field. You can search the list of customers by name or email. This fills out the other fields in the section.
|
||||
2. If this is a new customer, enter the customer's details such as first name or email.
|
||||
6. Under the Shipping Address section, enter the customer's shipping address details.
|
||||
7. Under the Billing Address section, either:
|
||||
1. Check the "Same as shipping address" checkbox to use the same details as the shipping address;
|
||||
2. Or uncheck the "Same as shipping address" checkbox and enter the billing address's details.
|
||||
8. Under the Metadata section, optionally enter custom key-value pairs.
|
||||
9. Once you're done, click on the Save button.
|
||||
6. In the last step, confirm that all the information is correct:
|
||||
1. To edit any of the information, click on the "Details" step to go back.
|
||||
2. To add a discount, toggle the "Add discount" button and enter the discount code.
|
||||
3. To disable sending a notification to the customer about their draft order, toggle the "Send notifications" button.
|
||||
4. Once you’re done, click on the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Open Draft Order’s Details
|
||||
|
||||
To open a draft order’s details page:
|
||||
|
||||
1. Go to Orders → Draft Orders.
|
||||
2. Select the draft order you want to view.
|
||||
|
||||
---
|
||||
|
||||
## Edit Shipping Address
|
||||
|
||||
{/* TODO check steps after #3 */}
|
||||
|
||||
To edit the shipping address of a draft order:
|
||||
|
||||
1. Open the draft order details page.
|
||||
2. In the Customer section, click on the <InlineIcon Icon={EllipsisHorizontal} alt="three dots" /> icon at the top right.
|
||||
3. Choose "Edit shipping address" from 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
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Canceling a draft order is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
{/* TODO check steps after #2 */}
|
||||
|
||||
To cancel a draft order:
|
||||
|
||||
1. Open the draft order details page.
|
||||
2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three dots" /> icon at the top right of the first section.
|
||||
3. Choose Cancel from the dropdown.
|
||||
4. Confirm canceling the draft order by clicking the “Yes, remove” button in the pop-up.
|
||||
|
||||
---
|
||||
|
||||
## Mark Draft Order as Paid
|
||||
|
||||
<Note>
|
||||
|
||||
Marking a draft order as paid creates a new order associated with this draft order.
|
||||
|
||||
</Note>
|
||||
|
||||
{/* TODO check steps after #2 */}
|
||||
|
||||
To mark a draft order as paid:
|
||||
|
||||
1. Open the draft order details page.
|
||||
2. In the Summary section, click on the <InlineIcon Icon={EllipsisHorizontal} alt="three dots" /> icon at the top right.
|
||||
3. Choose "Mark as paid" from the dropdown.
|
||||
4. Confirm your action by clicking the “Mark paid” button in the pop-up.
|
||||
|
||||
You can find the created order in the Orders page.
|
||||
|
||||
---
|
||||
|
||||
## Go to Associated Order
|
||||
|
||||
<Note type="check">
|
||||
|
||||
The draft order must be [marked as paid](#mark-draft-order-as-paid) first.
|
||||
|
||||
</Note>
|
||||
|
||||
To go to the order associated with the draft order.
|
||||
|
||||
1. Go to Orders → Draft Orders.
|
||||
2. Find the draft order you're looking for in the list.
|
||||
3. Click the link under the Order column.
|
||||
@@ -0,0 +1,98 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
import {
|
||||
EllipsisHorizontal,
|
||||
} from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Edit an Order’s Items`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
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 an order to:
|
||||
|
||||
- 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 saved 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. If there are any additional payment required, you have to handle that manually with the customer.
|
||||
|
||||
---
|
||||
|
||||
## Request an Order Edit
|
||||
|
||||
<Note type="check">
|
||||
|
||||
You can’t request an order edit for an order if another order edit is already requested.
|
||||
|
||||
</Note>
|
||||
|
||||
{/* TODO check info for correctness */}
|
||||
|
||||
To request an order edit:
|
||||
|
||||
1. Open the order details page.
|
||||
2. In the Summary section, click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon.
|
||||
3. In the new form that opens:
|
||||
1. To add an item:
|
||||
1. Click on the “Add items” button.
|
||||
2. In the drawer that opens, click on the checkbox next to the items you want to add.
|
||||
3. Once done, click on the “Add products” button.
|
||||
2. To update an item’s quantity:
|
||||
1. Find the item in the table under the "Current Items" section.
|
||||
2. Change the value under the Quantity column.
|
||||
5. To delete an item:
|
||||
1. Find the item in the table under the "Current Items" section.
|
||||
2. Change the value under the Quantity column to `0`.
|
||||
6. Optionally enter a note for the customer to see in the Note field.
|
||||
4. Once done, click on the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Force Confirm an Order
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Force-confirming an order makes irreversible changes to the order.
|
||||
|
||||
</Note>
|
||||
|
||||
<Note>
|
||||
|
||||
If the order edit requires additional payment, you’ll have to manually receive that payment from the customer.
|
||||
|
||||
</Note>
|
||||
|
||||
{/* TODO check info for correctness */}
|
||||
|
||||
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:
|
||||
|
||||
{/* TODO check info for correctness */}
|
||||
|
||||
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,98 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
---
|
||||
|
||||
import {
|
||||
EllipsisHorizontal,
|
||||
} from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Exchanges`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
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
|
||||
|
||||
{/* TODO check info for correctness */}
|
||||
|
||||
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
|
||||
|
||||
{/* TODO check steps for correctness */}
|
||||
|
||||
<Note type="check">
|
||||
|
||||
The order’s payment must be captured and the order's items must be fulfilled first.
|
||||
|
||||
</Note>
|
||||
|
||||
To create an order exchange:
|
||||
|
||||
1. Go to an order’s details page.
|
||||
2. In the Timeline section, click on the <InlineIcon Icon={EllipsisHorizontal} alt="three dots" /> icon.
|
||||
3. Click on Register Exchange from the dropdown.
|
||||
4. In the new form that opens, there are two steps:
|
||||
1. In the first step, choose the items to return to the customer. Once you're done, click on the Continue button.
|
||||
2. In the second step:
|
||||
1. For each item under the "Items to return" section, enter the item's quantity, choose the return reason, and optionally provide a note that's shown to the customer.
|
||||
2. Under the Shipping section:
|
||||
1. Choose the location the item is returned to.
|
||||
2. Choose the shipping method used to return the item.
|
||||
3. Under the "Items to send" section:
|
||||
1. To add items to send, click the "Add items" button and choose the Products from the drawer, then click "Add products".
|
||||
2. To change an item's quantity, change the value under its Quantity column.
|
||||
4. If a refund is required, you can change the amount refunded by toggling the "Custom refund" button and entering the new amount in the field shown.
|
||||
5. To disable sending a notification to the customer regarding the exchange, toggle the "Send notifications" button.
|
||||
5. Once you’re done, click the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Mark an Exchange’s Return as Received
|
||||
|
||||
{/* TODO check steps for correctness */}
|
||||
|
||||
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
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Canceling an exchange is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
<Note type="check">
|
||||
|
||||
The return of the exchange must be canceled first. If the return has been marked as received, the exchange can’t be canceled.
|
||||
|
||||
</Note>
|
||||
|
||||
{/* TODO check steps for correctness */}
|
||||
|
||||
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 <InlineIcon Icon={EllipsisHorizontal} 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 <InlineIcon Icon={EllipsisHorizontal} 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,63 @@
|
||||
---
|
||||
sidebar_position: 9
|
||||
---
|
||||
|
||||
import { BellAlert, ArrowDownTray } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Export Orders`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll learn how to export all orders in your Medusa store.
|
||||
|
||||
When you export your orders, you download a CSV file with the orders' details.
|
||||
|
||||
## Export List of Orders
|
||||
|
||||
{/* TODO check for correctness */}
|
||||
|
||||
To export orders:
|
||||
|
||||
1. Go to Orders page.
|
||||
2. Click on the Export button at the top right.
|
||||
3. Click Export in the window that opens.
|
||||
4. To check the export's status, click the <InlineIcon Icon={BellAlert} alt="bell" /> icon at the top right of the page. You should see your new export loading.
|
||||
6. Once the export is ready, click the <InlineIcon Icon={ArrowDownTray} alt="download" /> icon.
|
||||
|
||||
<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.
|
||||
|
||||
</Note>
|
||||
|
||||
---
|
||||
|
||||
## Cancel an Order Export
|
||||
|
||||
{/* TODO check for correctness and if feature is still available */}
|
||||
|
||||
To cancel an order export:
|
||||
|
||||
1. Click on the <InlineIcon Icon={BellAlert} 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
|
||||
|
||||
{/* TODO check for correctness and if feature is still available */}
|
||||
|
||||
<Note>
|
||||
|
||||
You can only delete a finished order export.
|
||||
|
||||
</Note>
|
||||
|
||||
To delete an order export:
|
||||
|
||||
1. Click on the <InlineIcon Icon={BellAlert} 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,93 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
sidebar_label: Manage Fulfillments
|
||||
---
|
||||
|
||||
import {
|
||||
EllipsisHorizontal,
|
||||
} from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Order's Fulfillments`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll learn about order fulfillments and how to manage them, including how to create fulfillments and mark them as shipped.
|
||||
|
||||
## Create Fulfillment
|
||||
|
||||
{/* TODO check after #4 */}
|
||||
|
||||
To create a fulfillment for an order:
|
||||
|
||||
1. Open the order details page.
|
||||
2. Scroll down to the Unfulfilled Items section.
|
||||
3. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon.
|
||||
4. Choose "Create Fulfillment" from the dropdown.
|
||||
5. In the form 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 a notification that a fulfillment has been created, uncheck the “Send notifications” checkbox.
|
||||
6. Once done, click on the "Create fulfillment" button.
|
||||
|
||||
Check the fulfillment details in the Fulfillment and Timeline sections.
|
||||
|
||||
---
|
||||
|
||||
## Mark a Fulfillment Shipped
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Marking a fulfillment shipped is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
<Note type="check">
|
||||
|
||||
You must [create a fulfillment](#create-fulfillment) first.
|
||||
|
||||
</Note>
|
||||
|
||||
{/* TODO check after #4 */}
|
||||
|
||||
To mark a fulfillment as shipped in an order:
|
||||
|
||||
1. Open the order details page.
|
||||
2. Scroll down to the Fulfillment section. If you have more than one fulfillment, find the fulfillment you're looking for.
|
||||
3. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the section.
|
||||
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 a notification that the fulfillment has been shipped, uncheck the “Send notifications” checkbox.
|
||||
6. Once you’re done, click the Complete button.
|
||||
|
||||
Shipment details are shown in the Timeline section.
|
||||
|
||||
---
|
||||
|
||||
## Cancel a Fulfillment
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Canceling a fulfillment is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
<Note type="check">
|
||||
|
||||
Only a fulfillment that hasn’t been marked as shipped can be canceled.
|
||||
|
||||
</Note>
|
||||
|
||||
{/* TODO check after #4 */}
|
||||
|
||||
To cancel a fulfillment in an order:
|
||||
|
||||
1. Open the order details page.
|
||||
2. Scroll down to the Fulfillment section. If you have more than one fulfillment, find the fulfillment you're looking for.
|
||||
3. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the section.
|
||||
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,230 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
sidebar_label: Manage Details
|
||||
---
|
||||
|
||||
import {
|
||||
ArrowsPointingOut,
|
||||
EllipsisHorizontal,
|
||||
FaceSmile,
|
||||
ArrowUpCircleSolid
|
||||
} from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Order Details`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll learn how to find an order’s details page, what information you find on the order details page, and how to manage 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
|
||||
|
||||
### First Section
|
||||
|
||||
The first section of the page shows the summary of the order, including its number, payment and fulfillment status, date created, sales channel, and more.
|
||||
|
||||
### Summary
|
||||
|
||||
This section includes the summary of the items the customer purchased as well as totals related to taxes, shipping, and more.
|
||||
|
||||
### Customer
|
||||
|
||||
This section includes the customer’s details, including their contact information and shipping address.
|
||||
|
||||
### Activity
|
||||
|
||||
{/* TODO check if these details are correct */}
|
||||
|
||||
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.
|
||||
|
||||
### Payments
|
||||
|
||||
This section includes details related to the order’s payments, showing a full history of the changes in the payment's status. It also provides actions such as capture the authorized payment.
|
||||
|
||||
## Unfulfilled Items
|
||||
|
||||
This section includes the details of items that haven't been fulfilled yet. It also provides the action to fulfill items.
|
||||
|
||||
### Fulfillment
|
||||
|
||||
For every fulfillment you create, a new fulfillment section is added with its number in the title. The section includes details of the fulfillment and actions to perform on it.
|
||||
|
||||
### JSON
|
||||
|
||||
This section is useful for developers to view the JSON structure of the order's data.
|
||||
|
||||
To view the JSON structure, click on the <InlineIcon Icon={ArrowsPointingOut} alt="Expand" /> icon.
|
||||
|
||||
---
|
||||
|
||||
## Manage Item Allocation
|
||||
|
||||
When a customer places an order, the ordered quantity of the items's underlying product variant is considered reserved (or allocated) in a stock location. This is only applied to product variants that have "Manage Inventory" enabled.
|
||||
|
||||
Manage the item's allocation by managing the location that the item's quantity is reserved from.
|
||||
|
||||
{/* TODO check information in this section for correctness */}
|
||||
|
||||
{/* TODO maybe the following sections belong to one section. */}
|
||||
|
||||
### Allocate an Item
|
||||
|
||||
Items are allocated by default. However, in some edge cases you may need to allocate an item manually.
|
||||
|
||||
To allocate an item:
|
||||
|
||||
{/* TODO check information after #5 */}
|
||||
|
||||
1. Go to the order details page.
|
||||
2. Scroll to the Summary section.
|
||||
3. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dot" /> icon at the top right of the section.
|
||||
4. Choose "Allocate items" from the dropdown.
|
||||
5. 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.
|
||||
6. 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:
|
||||
|
||||
{/* TODO check information after #5 */}
|
||||
|
||||
1. Go to the order details page.
|
||||
2. Scroll to the Summary section.
|
||||
3. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dot" /> icon at the top right of the section.
|
||||
4. Choose "Allocate items" from the dropdown.
|
||||
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
|
||||
|
||||
{/* TODO check information after #5 */}
|
||||
|
||||
To delete an item allocation:
|
||||
|
||||
1. Go to the order details page.
|
||||
2. Scroll to the Summary section.
|
||||
3. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dot" /> icon at the top right of the section.
|
||||
4. Choose "Allocate items" from the dropdown.
|
||||
5. In the new window that opens, click on the "Delete allocation" button.
|
||||
|
||||
---
|
||||
|
||||
## Edit the Shipping Address
|
||||
|
||||
{/* TODO check information after #4 */}
|
||||
|
||||
To edit the shipping address used for an order:
|
||||
|
||||
1. Open the order details page.
|
||||
2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dot" /> icon at the top right of the Customer section.
|
||||
3. Click on "Edit shipping address" from the dropdown.
|
||||
4. This opens a drawer to edit the shipping address.
|
||||
5. Once you’re done, click on the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Edit the Billing Address
|
||||
|
||||
{/* TODO check information after #4 */}
|
||||
|
||||
To edit the billing address used for an order:
|
||||
|
||||
1. Open the order details page.
|
||||
2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dot" /> icon at the top right of the Customer section.
|
||||
3. Click on "Edit billing address" from the dropdown.
|
||||
4. This opens a drawer to edit the billing address.
|
||||
5. Once you’re done, click on the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Edit Email Address
|
||||
|
||||
{/* TODO check information after #4 */}
|
||||
|
||||
To edit the email address associated with an order:
|
||||
|
||||
1. Open the order details page.
|
||||
2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dot" /> icon at the top right of the Customer section.
|
||||
3. Click on "Edit email" from the dropdown.
|
||||
4. This opens a drawer to edit the email address.
|
||||
5. Once you’re done, click on the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Transfer Customer Ownership
|
||||
|
||||
{/* TODO check information after #4 */}
|
||||
|
||||
To change the customer that placed this order:
|
||||
|
||||
1. Open the order details page.
|
||||
2. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dot" /> icon at the top right of the Customer section.
|
||||
3. Click on "Transfer ownership" from the dropdown.
|
||||
4. In the new window that opens choose the new customer to own this order.
|
||||
5. Once done, click on the Confirm button.
|
||||
|
||||
---
|
||||
|
||||
## Add a Note
|
||||
|
||||
{/* TODO check information for correctness */}
|
||||
|
||||
To add a note to an order:
|
||||
|
||||
1. Open the order details page.
|
||||
2. In the Timeline section, enter the note in the text field. You can also choose emojis by clicking the <InlineIcon Icon={FaceSmile} alt="emoji" /> icon.
|
||||
3. Once done, click on the <InlineIcon Icon={ArrowUpCircleSolid} alt="send" /> icon.
|
||||
|
||||
The note is added and shown in the timeline.
|
||||
|
||||
---
|
||||
|
||||
## Delete a Note
|
||||
|
||||
{/* TODO check information for correctness */}
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Deleting notes is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
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 <InlineIcon Icon={EllipsisHorizontal} 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
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Canceling an order is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
To cancel an order:
|
||||
|
||||
1. Open the order details page.
|
||||
2. In the first section showing the order’s number, click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> at the top right.
|
||||
3. Click on Cancel Order from the dropdown.
|
||||
4. Confirm canceling the order by clicking the “Continue” button in the pop-up.
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
sidebar_autogenerate_exclude: true
|
||||
---
|
||||
|
||||
export const metadata = {
|
||||
title: `Orders`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll get an overview of the orders listing page.
|
||||
|
||||
## Overview
|
||||
|
||||
When customers buy one or more products, their order appears on the Orders page. There, 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 page.
|
||||
|
||||
---
|
||||
|
||||
## View List of Orders
|
||||
|
||||
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, sales channel, and fulfillment and payment status.
|
||||
|
||||
---
|
||||
|
||||
## View List of Draft Orders
|
||||
|
||||
When you open the Orders page, the Draft Orders sub-item is shown in the sidebar. Click it to view the list of draft orders.
|
||||
|
||||
{/* TODO check if the details are correct. */}
|
||||
|
||||
In the list, you can see draft 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/page.mdx)
|
||||
- [Manage Order’s Payment](./payments/page.mdx)
|
||||
- [Manage Order’s Fulfillment](./fulfillments/page.mdx)
|
||||
- [Manage Draft Orders](./drafts/page.mdx)
|
||||
- [Manage Order Returns](./returns/page.mdx)
|
||||
- [Manage Order Claims](./claims/page.mdx)
|
||||
- [Manage Order Exchanges](./exchange/page.mdx)
|
||||
- [Export Orders](./export/page.mdx)
|
||||
@@ -0,0 +1,71 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
sidebar_label: Manage Payments
|
||||
---
|
||||
|
||||
import {
|
||||
EllipsisHorizontal,
|
||||
} from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Order's Payments`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
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
|
||||
|
||||
<Note>
|
||||
|
||||
Payment is only captured once.
|
||||
|
||||
</Note>
|
||||
|
||||
To capture an order’s payment:
|
||||
|
||||
1. Open the order details page.
|
||||
2. Scroll to the Payments section.
|
||||
3. Click on the Capture button.
|
||||
|
||||
---
|
||||
|
||||
## Refund Payment
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Refunding payments is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
<Note type="check">
|
||||
|
||||
Payment can only be refunded if it's captured.
|
||||
|
||||
</Note>
|
||||
|
||||
{/* TODO check info after #5 */}
|
||||
|
||||
To refund an order’s payment:
|
||||
|
||||
1. Open the order details page.
|
||||
2. Scroll to the Payment section.
|
||||
3. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon.
|
||||
4. Choose "Refund" from the dropdown.
|
||||
5. In the drawer that opens:
|
||||
- Enter the amount to refund in the "Refund amount" field.
|
||||
- In the Reason field, choose a reason for the refund.
|
||||
- Optionally enter a note that the customer can view in the Note field.
|
||||
- If you don’t want the customer to receive a notification that the payment has been refunded, uncheck the “Send notifications” checkbox.
|
||||
6. Once you’re done, click on the Complete button.
|
||||
|
||||
Check refund details in the Payment, Summary, and Timeline sections.
|
||||
@@ -0,0 +1,112 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
sidebar_label: Manage Returns
|
||||
---
|
||||
|
||||
import {
|
||||
EllipsisHorizontal,
|
||||
} from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Order’s Returns`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
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 order returns can be requested:
|
||||
|
||||
1. The customer requests a return for an order through the storefront, which the admin user can view on the admin.
|
||||
2. The admin user requests to receive a return from the customer. The customer is informed about this through an email.
|
||||
|
||||
After a return is requested, the admin user chooses 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, find any returns requested, whether by admin users or by customers.
|
||||
|
||||
---
|
||||
|
||||
## Request a Return for an Order
|
||||
|
||||
{/* TODO check info for correctness */}
|
||||
|
||||
To request a return for an order:
|
||||
|
||||
1. Open the order details page.
|
||||
2. In the Timeline section, click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right.
|
||||
3. Choose "Request Return" from the dropdown.
|
||||
4. In the new window that opens, there are two steps to follow:
|
||||
1. In the first step:
|
||||
1. Choose the items in the order that you want to request the return.
|
||||
2. Once you're done, click on the "Continue" button.
|
||||
2. In the second step:
|
||||
1. For each item under the "Items to return" section, enter the quantity, choose the [Reason](../../settings/return-reasons/page.mdx), and optionally add a note.
|
||||
2. Under the Shipping section:
|
||||
1. Choose the location to return items to.
|
||||
2. Choose the shipping method used to return the items.
|
||||
3. To change the refunded value:
|
||||
1. Toggle the "Custom refund" button.
|
||||
2. Enter the custom amount in the field shown.
|
||||
4. To disable sending a notification to the customer that the order return is requested, toggle the "Send notifications" button
|
||||
5. Once done, click on the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Receive Return
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Once the return is marked as received, a refund is issued to the customer.
|
||||
|
||||
</Note>
|
||||
|
||||
<Note type="check">
|
||||
|
||||
The order's payment must be captured first.
|
||||
|
||||
</Note>
|
||||
|
||||
{/* TODO check info for correctness */}
|
||||
|
||||
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
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Canceling a return is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
<Note type="check">
|
||||
|
||||
The return must be [marked as received](#receive-return) first.
|
||||
|
||||
</Note>
|
||||
|
||||
{/* TODO check info for correctness */}
|
||||
|
||||
To cancel a return:
|
||||
|
||||
1. Open the order details page.
|
||||
2. In the Timeline section, find the return requested and click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon.
|
||||
3. Click on “Cancel return” in the dropdown.
|
||||
Reference in new issue
Block a user