From 0cbe71597e6091d030df8c04ea7da867e22f5acd Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Mon, 17 Feb 2025 18:16:23 +0200 Subject: [PATCH] docs: update orders user guide (#11498) --- .../user-guide/app/orders/claims/page.mdx | 205 ++++------------ .../user-guide/app/orders/drafts/page.mdx | 139 ----------- www/apps/user-guide/app/orders/edit/page.mdx | 94 ++++--- .../user-guide/app/orders/exchange/page.mdx | 98 -------- .../user-guide/app/orders/exchanges/page.mdx | 97 ++++++++ .../user-guide/app/orders/export/page.mdx | 63 ----- .../app/orders/fulfillments/page.mdx | 181 ++++++++++---- .../user-guide/app/orders/manage/page.mdx | 232 +++++++----------- www/apps/user-guide/app/orders/page.mdx | 41 ++-- .../user-guide/app/orders/payments/page.mdx | 136 ++++++++-- .../user-guide/app/orders/returns/page.mdx | 147 ++++++----- www/apps/user-guide/generated/edit-dates.mjs | 20 +- www/apps/user-guide/generated/sidebar.mjs | 57 ++--- www/apps/user-guide/sidebar.mjs | 52 +++- 14 files changed, 696 insertions(+), 866 deletions(-) delete mode 100644 www/apps/user-guide/app/orders/drafts/page.mdx delete mode 100644 www/apps/user-guide/app/orders/exchange/page.mdx create mode 100644 www/apps/user-guide/app/orders/exchanges/page.mdx delete mode 100644 www/apps/user-guide/app/orders/export/page.mdx diff --git a/www/apps/user-guide/app/orders/claims/page.mdx b/www/apps/user-guide/app/orders/claims/page.mdx index c534678c33..710b1bc64b 100644 --- a/www/apps/user-guide/app/orders/claims/page.mdx +++ b/www/apps/user-guide/app/orders/claims/page.mdx @@ -4,19 +4,22 @@ sidebar_position: 8 import { EllipsisHorizontal, + PencilSquare } from "@medusajs/icons" export const metadata = { - title: `Manage Order's Claims`, + title: `Manage Order Claims`, } # {metadata.title} -In this document, you’ll learn what claims are, how to create them, and more. +In this guide, you’ll learn what claims are, how to create them, and more. -## Overview +## Order Claims 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). +If a customer receives faulty or incorrect items for an order, you can create a claim. A claim allows you to either replace or return an item for a customer, then issue a refund. + +![Claim in Activity section](https://res.cloudinary.com/dza7lstvk/image/upload/v1739804058/User%20Guide/Screenshot_2025-02-17_at_4.53.59_PM_fw1pmy.png) --- @@ -24,179 +27,59 @@ If a customer receives a faulty or incorrect items for an order, you can create -If the claim has a refund amount, the refund is issued to the customer right after the claim is created. +Changes made by a claim can't be canceled. Make sure to review the claim before confirming it. - +You can create an order claim after the order's items have been [delivered](../fulfillments/page.mdx#mark-fulfillment-as-delivered). -You must capture the order’s payment and create fulfillment in the order for the items included in the claim first. +To create an order claim: - - -{/* TODO check steps for correctness */} - -1. Open the order details page. -2. In the Timeline section, click on the 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 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 */} - - - -Canceling a return is irreversible. - - - -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 icon. -3. Click on “Cancel return” in the dropdown. - ---- - -## Manage a Claim’s Fulfillments - - - -This section only applies if the claim has replacement items. - - - -### 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 icon. -3. Click on Fulfill Claim in the dropdown. +1. Go to an order’s details page. +2. In the Summary section, click on the icon at the top right. +3. Choose "Create Claim" from 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. + - To add items to be returned: + - Click on the "Add items" button in the "Inbound" section. + - In the list that opens, click on the checkbox next to the items you want the customer to return. + - Once done, click on the "Save" button. + - You can then change the quantity to return or manage the item's details by clicking the icon next to it. + - For the inbound items: + - For the Location field, choose the location to return the items to. + - For the Return Shipping field, you can optionally choose the shipping method to return the items with. + - Choosing a return shipping method adds its cost to the claim total. You can modify the cost by clicking the icon next to the Return Shipping total, then entering the new cost. + - You can optionally add an outbound item to be sent to the customer in replacement: + - Click on the "Add items" button in the "Outbound" section. + - In the list that opens, click on the checkbox next to the items you want to send to the customer. + - Once done, click on the "Save" button. + - You can then change the quantity to send or remove the item by clicking the icon next to it and choosing "Remove" from the dropdown. + - For outbound items, choose the shipping method used to send the items in the Outbound Shipping field. + - The shipping method's cost is added to the claim total. To edit its cost: + - Click the icon next to the Outbound Shipping total. + - Enter the new cost in the input shown. + - If you want the customer to receive a notification that a claim has been created, check the “Send notifications” toggle. +5. Once done, click on the "Confirm Claim" button, then confirm the action by clicking the "Continue" button in the pop-up. -### Mark a Claim’s Fulfillment Shipped +![Create Claim Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739803985/User%20Guide/Screenshot_2025-02-17_at_4.52.40_PM_drn24m.png) -{/* 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 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 - - - -Canceling a fulfillment is irreversible. - - - - - -Only a fulfillment that hasn’t been marked as shipped can be canceled. - - - -{/* 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 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. +The claim will be created and you can see it in the Activity section of the order’s details page. If you added outbound items, they will also be added to the "Unfulfilled Items" section. --- -## Cancel a Claim +## Handle Outstanding Payment of a Claim -{/* TODO check info for correctness */} +After creating a claim, you can check if there are any outstanding amounts (to be captured from the customer or returned) in the Summary section. -### For Refund Claims +To handle outstanding amounts by refunding or capturing the payment, refer to the [Payments guide](../payments/page.mdx#handling-outstanding-amounts). -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 +## Managing Returned Items in a Claim - +The items to be returned from the customer as part of the claim can be managed similarly to a return. Once you receive the items from the customer, you can mark them as received as explained in the [Returns guide](../returns/page.mdx#mark-return-items-as-received). -Canceling a claim is irreversible. +--- - +## Fulfill Outbound Items in a Claim - - -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 icon. -3. Click on Cancel Claim in the dropdown. -4. Confirm canceling the fulfillment by clicking the “Yes, remove” button in the pop-up. +As mentioned earlier, the outbound items of a claim are added into the "Unfulfilled Items" section. To fulfill and deliver these items to the customer, refer to the [Fulfillment guide](../fulfillments/page.mdx#create-fulfillment). diff --git a/www/apps/user-guide/app/orders/drafts/page.mdx b/www/apps/user-guide/app/orders/drafts/page.mdx deleted file mode 100644 index 9dd44a7b56..0000000000 --- a/www/apps/user-guide/app/orders/drafts/page.mdx +++ /dev/null @@ -1,139 +0,0 @@ ---- -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 tab 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 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 - - - -Canceling a draft order is irreversible. - - - -{/* TODO check steps after #2 */} - -To cancel a draft order: - -1. Open the draft order details page. -2. Click on the 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 - - - -Marking a draft order as paid creates a new order associated with this draft order. - - - -{/* 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 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 - - - -The draft order must be [marked as paid](#mark-draft-order-as-paid) first. - - - -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. diff --git a/www/apps/user-guide/app/orders/edit/page.mdx b/www/apps/user-guide/app/orders/edit/page.mdx index 3696ba0be7..9900dc9b9a 100644 --- a/www/apps/user-guide/app/orders/edit/page.mdx +++ b/www/apps/user-guide/app/orders/edit/page.mdx @@ -12,9 +12,9 @@ export const metadata = { # {metadata.title} -In this document, you’ll learn how to edit items in an order. This includes adding, updating, or deleting items. +In this guide, you’ll learn how to edit items in an order. This includes adding, updating, or deleting items. -## Overview +## How Order Edits Work Using the Medusa Admin, you can edit an order to: @@ -22,77 +22,93 @@ Using the Medusa Admin, you can edit an order to: - 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. +![Order edit requested section](https://res.cloudinary.com/dza7lstvk/image/upload/v1739787160/User%20Guide/Screenshot_2025-02-17_at_12.09.50_PM_bap56a.png) -There are two ways to confirm an order edit request: +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. +2. Or you force-confirm the order edit. You can then handle any outstanding amount. --- ## Request an Order Edit - - -You can’t request an order edit for an order if another order edit is already requested. - - - -{/* TODO check info for correctness */} +You can only request one order edit at a time. If you need to make additional changes, you’ll have to cancel the current order edit and request a new one, or force-confirm the current order edit. To request an order edit: 1. Open the order details page. 2. In the Summary section, click on the icon. -3. In the new form that opens: +3. Choose "Edit Order" from the dropdown. +4. In the 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. + 1. Click on the "Add items" button. + 2. In the list that opens, click on the checkbox next to the items you want to add. + 3. Once done, click on the "Save" button. The item will be added under the "Items" section with the "New" badge. You can also update its quantity. 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. + 1. Find the item under the "Items" section. + 2. Change the value for the "qty" input. This adds the "Modified" badge to the item. + 3. To duplicate an item: + 1. Find the item under the "Items" section. + 2. Click on the icon. + 3. Choose "Duplicate" from the dropdown. A new item with the same details will be added under the "Items" section with the "New" badge. + 4. To delete an item: + 1. Find the item under the "Items" section. + 2. Click on the icon. + 3. Choose "Remove" from the dropdown. + - If you remove a newly added item, the item will be removed from the list. Otherwise, the item will have a "Removed" badge and you can't edit its quantity. + - To undo removing an item in the order, click on the icon next to it and choose "Undo" from the dropdown. + 5. Optionally enter a note for the customer to see in the Note field. + 6. If you want to send a notification to the customer about the order edit, check the "Send notifications" toggle. +5. Once done, click on the "Confirm Edit" button. +6. Confirm requesting the order edit by clicking the "Continue" button in the pop-up. + +![Order Edit Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739792815/User%20Guide/Screenshot_2025-02-17_at_1.46.35_PM_quugt5.png) + +Once requested, a new section "Order edit requested" will show at the top of the order's details page with the edit's details. --- -## Force Confirm an Order +## Force Confirm an Order Edit + +As mentioned in the beginning of this guide, the customer must confirm the order edit for the changes to be saved on the order. However, you can force-confirm an order edit if you need to make the changes immediately, or if the customer delegates you to do so. -Force-confirming an order makes irreversible changes to the order. +Force-confirming an order edit makes irreversible changes to the order. - +To force confirm an order edit: -If the order edit requires additional payment, you’ll have to manually receive that payment from the customer. +1. Open the order's details page. +2. Click the "Force confirm" button at the bottom right of the "Order edit requested" section. - +This applies the changes to the order edit. If there are any additional payments required, you'll have to mark the order as paid or share a payment link manually. -{/* TODO check info for correctness */} +### Allocating New Items -To force confirm an order: +For new items, you may see an "Allocate Items" button indicating that you need to allocate them manually from a stock location. Refer to [this guide](../manage/page.mdx#allocate-order-items-manually) to learn how to do that. -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. +### Handle Outstanding Amounts after Order Edit + +After the order edit is confirmed, you can check if there are any outstanding amounts (to be captured from the customer or returned) in the Summary section. + +To handle outstanding amounts by refunding or capturing the payment, refer to the [Payments guide](../payments/page.mdx#handling-outstanding-amounts). + +### Fulfilling New Items + +If the order edit added new items to the order, they'll be shown in the "Unfulfilled Items" section after the order edit is confirmed. You can then fulfill them as explained in [this guide](../fulfillments/page.mdx). --- ## Cancel an Order Edit Request -To cancel an order-edit request: +If an order edit request hasn't been confirmed yet, you can cancel it. -{/* TODO check info for correctness */} +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. \ No newline at end of file +2. Click the "Cancel" button at the bottom right of the "Order edit requested" section. + +The order edit will be canceled and the changes won't be saved on the order. The customer also can't confirm the order edit anymore. diff --git a/www/apps/user-guide/app/orders/exchange/page.mdx b/www/apps/user-guide/app/orders/exchange/page.mdx deleted file mode 100644 index 03321ff426..0000000000 --- a/www/apps/user-guide/app/orders/exchange/page.mdx +++ /dev/null @@ -1,98 +0,0 @@ ---- -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 */} - - - -The order’s payment must be captured and the order's items must be fulfilled first. - - - -To create an order exchange: - -1. Go to an order’s details page. -2. In the Timeline section, click on the 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 - - - -Canceling an exchange is irreversible. - - - - - -The return of the exchange must be canceled first. If the return has been marked as received, the exchange can’t be canceled. - - - -{/* 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 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 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. diff --git a/www/apps/user-guide/app/orders/exchanges/page.mdx b/www/apps/user-guide/app/orders/exchanges/page.mdx new file mode 100644 index 0000000000..9f2017755d --- /dev/null +++ b/www/apps/user-guide/app/orders/exchanges/page.mdx @@ -0,0 +1,97 @@ +--- +sidebar_position: 7 +--- + +import { + EllipsisHorizontal, + PencilSquare +} from "@medusajs/icons" + +export const metadata = { + title: `Manage Exchanges`, +} + +# {metadata.title} + +In this guide, you’ll learn how to manage order exchanges. + +## Order Exchange Overview + +After items have been delivered to the customer, you can create an exchange where the customer returns the items and you send them a new one. Order exchanges are useful if the customer received an incorrect item or they changed their mind about the item they purchased, and you want to offer them a replacement. + +![Exchange requested in Activity section](https://res.cloudinary.com/dza7lstvk/image/upload/v1739801263/User%20Guide/Screenshot_2025-02-17_at_4.07.27_PM_exugug.png) + +--- + +## Create an Order Exchange + +You can create an order exchange after the order's items have been [delivered](../fulfillments/page.mdx#mark-fulfillment-as-delivered). + +To create an order exchange: + +1. Go to an order’s details page. +2. In the Summary section, click on the icon at the top right. +3. Choose "Create Exchange" from the dropdown. +4. In the form that opens: + - To add items to be returned: + - Click on the "Add items" button in the "Inbound" section. + - In the list that opens, click on the checkbox next to the items you want the customer to return. + - Once done, click on the "Save" button. + - You can then change the quantity to return or manage the item's details by clicking the icon next to it. + - For the inbound items: + - For the Location field, choose the location to return the items to. + - For the Return Shipping field, you can optionally choose the shipping method to return the items with. + - Choosing a return shipping method adds its cost to the exchange total. You can modify the cost by clicking the icon next to the Return Shipping total, then entering the new cost. + - To add an item to be sent to the customer: + - Click on the "Add items" button in the "Outbound" section. + - In the list that opens, click on the checkbox next to the items you want to send to the customer. + - Once done, click on the "Save" button. + - You can then change the quantity to send or remove the item by clicking the icon next to it and choosing "Remove" from the dropdown. + - For outbound items, choose the shipping method used to send the items in the Outbound Shipping field. + - The shipping method's cost is added to the exchange total. To edit its cost: + - Click the icon next to the Outbound Shipping total. + - Enter the new cost in the input shown. + - If you want the customer to receive a notification that an exchange has been created, check the “Send notifications” toggle. +5. Once done, click on the "Confirm Exchange" button, then confirm the action by clicking the "Continue" button in the pop-up. + +![Create Exchange Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739801131/User%20Guide/Screenshot_2025-02-17_at_4.05.04_PM_m8afxr.png) + +You can then see the exchange in the Activity section. The outbound items to be sent to the customer will also be added to the "Unfulfilled Items" section. + +--- + +## Handle Outstanding Payment of an Exchange + +After creating an exchange, you can check if there are any outstanding amounts (to be captured from the customer or returned) in the Summary section. + +To handle outstanding amounts by refunding or capturing the payment, refer to the [Payments guide](../payments/page.mdx#handling-outstanding-amounts). + +--- + +## Managing Returned Items in an Exchange + +The items to be returned from the customer as part of the exchange can be managed similarly to a return. Once you receive the items from the customer, you can mark them as received as explained in the [Returns guide](../returns/page.mdx#mark-return-items-as-received). + +--- + +## Fulfill Outbound Items in an Exchange + +As mentioned earlier, the outbound items of an exchange are added into the "Unfulfilled Items" section. To fulfill and deliver these items to the customer, refer to the [Fulfillment guide](../fulfillments/page.mdx#create-fulfillment). + +--- + +## Cancel an Exchange + + + +Canceling an exchange is irreversible. You can only cancel the exchange if the outbound items haven't been fulfilled yet, and the inbound items haven't been marked as received. + + + +To cancel an exchange: + +1. Go to an order’s details page. +2. In the Activity section, click Cancel next to the exchange. +3. Confirm the cancellation by clicking the "Confirm" button in the pop-up. + +The exchange will be canceled, and outbound items added by the exchange will be removed from the Summary and Unfulfilled Items sections. diff --git a/www/apps/user-guide/app/orders/export/page.mdx b/www/apps/user-guide/app/orders/export/page.mdx deleted file mode 100644 index 274cf6d89c..0000000000 --- a/www/apps/user-guide/app/orders/export/page.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -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 icon at the top right of the page. You should see your new export loading. -6. Once the export is ready, click the icon. - - - -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 - -{/* TODO check for correctness and if feature is still available */} - -To cancel an order export: - -1. Click on the 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 */} - - - -You can only delete a finished order export. - - - -To delete an order export: - -1. Click on the icon at the top right of the page. -2. Find the export you want to delete. -3. Click on the Delete button. diff --git a/www/apps/user-guide/app/orders/fulfillments/page.mdx b/www/apps/user-guide/app/orders/fulfillments/page.mdx index 4e8f7b63b1..d03f7a4293 100644 --- a/www/apps/user-guide/app/orders/fulfillments/page.mdx +++ b/www/apps/user-guide/app/orders/fulfillments/page.mdx @@ -6,88 +6,173 @@ sidebar_label: Manage Fulfillments import { EllipsisHorizontal, } from "@medusajs/icons" +import { Table } from "docs-ui" export const metadata = { - title: `Manage Order's Fulfillments`, + title: `Manage Order 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. +In this guide, you’ll learn about order fulfillments and how to manage them, including how to create fulfillments and mark them as shipped. -## Create Fulfillment +## Overview -{/* TODO check after #4 */} +A fulfillment represents the process of picking, packing, and shipping items to a customer. You can fulfill all items in an order at once, or fulfill them separately. Then, for each fulfillment, you create a shipment that can have a tracking number, and finally mark the fulfillment as delivered. -To create a fulfillment for an order: +Fulfillment processes are handled by the fulfillment provider, such as UPS, associated with the shipping option that the customer has chosen during checkout. You can also use a different shipping option if necessary. -1. Open the order details page. -2. Scroll down to the Unfulfilled Items section. -3. Click on the 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. +Fulfillments can also be created for order changes like item edits and exchanges. + + + +### Order Fulfillment Statuses + +At the top of the order details page, you can see the fulfillment status of the order. The fulfillment status can be one of the following: + + + + + Status + Description + + + + + Not Fulfilled + The default status when an order is placed, indicating that the items in the order haven't been fulfilled yet. + + + Partially Fulfilled + Some items in the order have been fulfilled, but not all. + + + Fulfilled + All items in the order have been fulfilled. + + + Partially Shipped + Some items in the order have been shipped, but not all. + + + Shipped + All items in the order have been shipped. + + + Partially Delivered + Some items in the order have been marked as delivered, but not all. + + + Delivered + All items in the order have been marked as delivered. + + + Partially Returned + Some items in the order have been returned, but not all. + + + Returned + All items in the order have been returned. + + + Canceled + All order fulfillments have been canceled. + + +
--- -## Mark a Fulfillment Shipped +## Create Fulfillment + +To create a fulfillment for an order: + +1. Open the order's details page. +2. Scroll down to the Unfulfilled Items section. +3. Click on the icon. +4. Choose "Fulfill items" from the dropdown. +5. In the form that opens: + - For "Location", choose the location you want to fulfill the items from. By default, the location is set to that associated with the chosen shipping method. + - If you change the location, the available shipping methods will also change and that will impact which stock locations the items are fulfilled from. If the item doesn't have stock in the chosen location, the fulfillment will fail. + - For "Shipping method", choose the shipping method to fulfill the items with. By default, the shipping method is set to that chosen by the customer during checkout. + - The shipping methods available are based on the location you choose. If you want to choose a shipping method that isn't available, you need to change the location first. + - If you choose a shipping method with a different price, Medusa doesn't change the shipping total of the order. + - Under Items to fulfill, enter the quantity to fulfill for each item. This is also the quantity subtracted from the stock in the chosen location if Medusa manages the variant's inventory. + - If you don't want to fulfill an item, change its quantity to 0. + - If you don’t want the customer to receive a notification that a fulfillment has been created, uncheck the “Send notifications” toggle. +6. Once done, click on the "Create Fulfillment" button. + +![Fulfillment Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739781351/User%20Guide/Screenshot_2025-02-17_at_10.34.47_AM_nevpfa.png) + +After creating the fulfillment, a new section is shown with the header "Fulfillment #1", where `#1` is the number of the fulfillment in the order. If there are no unfulfilled items, the "Unfulfilled Items" section is removed. + +This can also change the order's fulfillment status to "Partially Fulfilled" or "Fulfilled" depending on the items fulfilled. + +--- + +## Add a Shipment to a Fulfillment + +After you create a fulfillment, you can add a shipment to it. A shipment can have a tracking number and marks the fulfillment as shipped. -Marking a fulfillment shipped is irreversible. +Adding a shipment to a fulfillment is irreversible. You can't cancel the fulfillment or the order afterwards. - +To add a shipment for a fulfillment: -You must [create a fulfillment](#create-fulfillment) first. +1. Open the order's details page. +2. Scroll down to the Fulfillment's section. If you have more than one fulfillment, find the fulfillment you're looking for. +3. Click on the "Mark as shipped" button at the bottom right of the section. +4. In the form that opens: + - To add a tracking number, click on the "Add tracking number" button, then enter a tracking number. + - If you don’t want the customer to receive a notification that the fulfillment has been shipped, uncheck the “Send notifications” toggle. +5. Once you’re done, click the Save button. + +![Shipment Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739783997/User%20Guide/Screenshot_2025-02-17_at_11.19.18_AM_o9qvsg.png) + +This changes the order's fulfillment status to "Partially Shipped" or "Shipped" depending on the items shipped. + +--- + +## Mark Fulfillment as Delivered + +You can mark a fulfillment as delivered, even if it hasn't been shipped. This can be useful if you deliver items to the customer using external methods. + + + +Marking a fulfillment as delivered is irreversible. You can't cancel the fulfillment or the order afterwards, and you can't add shipments to the fulfillment. -{/* TODO check after #4 */} +To mark the fulfillment as delivered: -To mark a fulfillment as shipped in an order: - -1. Open the order details page. +1. Open the order's 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 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. +3. Click on the "Mark as delivered" button at the bottom right of the section. +4. Confirm marking the order as delivered by clicking the "Continue" button in the pop-up -Shipment details are shown in the Timeline section. +![Mark as Delivered Pop-up](https://res.cloudinary.com/dza7lstvk/image/upload/v1739784298/User%20Guide/Screenshot_2025-02-17_at_11.24.48_AM_dpplxp.png) + +This changes the order's fulfillment status to "Partially Delivered" or "Delivered" depending on the items delivered. --- ## Cancel a Fulfillment - - -Canceling a fulfillment is irreversible. - - - - - -Only a fulfillment that hasn’t been marked as shipped can be canceled. - - - -{/* TODO check after #4 */} +You can cancel a fulfillment if you haven't shipped or marked it as delivered yet. This can be useful if you need to change the items fulfilled or if the customer cancels the order. To cancel a fulfillment in an order: -1. Open the order details page. +1. Open the order's 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 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. +4. Click on Cancel in the dropdown. +5. Confirm canceling the fulfillment by clicking the “Continue" button in the pop-up. + +![Cancel Fulfillment Pop-up](https://res.cloudinary.com/dza7lstvk/image/upload/v1739784441/User%20Guide/Screenshot_2025-02-17_at_11.27.05_AM_cd19ae.png) + +This changes the order's fulfillment status to "Canceled". Also, the "Unfulfilled Items" section is shown again, and you can create a new fulfillment. \ No newline at end of file diff --git a/www/apps/user-guide/app/orders/manage/page.mdx b/www/apps/user-guide/app/orders/manage/page.mdx index 7ce69dc95b..c610659b53 100644 --- a/www/apps/user-guide/app/orders/manage/page.mdx +++ b/www/apps/user-guide/app/orders/manage/page.mdx @@ -4,7 +4,7 @@ sidebar_label: Manage Details --- import { - ArrowsPointingOut, + ArrowUpRightOnBox, EllipsisHorizontal, FaceSmile, ArrowUpCircleSolid @@ -16,206 +16,158 @@ export const metadata = { # {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. +In this guide, 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. Order details include the general details, such as customer or address details. ## Open Order’s Details To open an order’s details: -1. Go to Orders. -2. Select one of the orders. +1. Go to Orders from the sidebar. +2. Select one of the orders to open its details page. -This opens the order’s details page. +![Order Details Page](https://res.cloudinary.com/dza7lstvk/image/upload/v1739543439/User%20Guide/Screenshot_2025-02-14_at_4.30.14_PM_nirqsy.png) + +### Order Summary Section + +The Summary section includes the summary of the items the customer purchased as well as totals related to taxes, shipping, and more. Use this section to get a quick overview of the order, [create returns](../returns/page.mdx), [create exchanges](../exchanges/page.mdx), or manage the order’s details as explained later in this guide. + +![Order Summary](https://res.cloudinary.com/dza7lstvk/image/upload/v1739543620/User%20Guide/Screenshot_2025-02-14_at_4.33.05_PM_ockept.png) + +### Customer Section + +The Customer section includes the customer’s details, including their contact information and shipping address. Use this section to view and edit the customer’s details pertaining to the order as explained later in this guide. + +![Customer Section](https://res.cloudinary.com/dza7lstvk/image/upload/v1739543745/User%20Guide/Screenshot_2025-02-14_at_4.35.27_PM_b4vav0.png) + +### Activity Section + +The Activity section of the order details page shows a summary of the changes made on the order. That includes payments captured, returned items, shipped items, and more. Use this section to get a quick overview of the order’s history and actions taken on it. + +![Activity Section](https://res.cloudinary.com/dza7lstvk/image/upload/v1739543897/User%20Guide/Screenshot_2025-02-14_at_4.37.58_PM_dcl0lw.png) + +### Payments Section + +The Payment section of the order details page includes details related to the order’s payments, showing a full history of the changes in the payment's status. Use this section to view and [manage the payments](../payments/page.mdx) related to the order. + +![Payments Section](https://res.cloudinary.com/dza7lstvk/image/upload/v1739544008/User%20Guide/Screenshot_2025-02-14_at_4.39.51_PM_vufzzu.png) + +## Unfulfilled Items Section + +The Unfulfilled Items section of the order details page includes the details of items that haven't been fulfilled yet. Use this section to view the items that need to be fulfilled and [create their fulfillments](../fulfillments/page.mdx). + +![Unfulfilled Items Section](https://res.cloudinary.com/dza7lstvk/image/upload/v1739544116/User%20Guide/Screenshot_2025-02-14_at_4.40.44_PM_vjrput.png) + +### Fulfillment Sections + +For every fulfillment you create, a new fulfillment section is added with its number in the title. The section includes details of the fulfillment. Use this section to view and [manage the fulfillment](../fulfillments/page.mdx). + +![Fulfillment Section](https://res.cloudinary.com/dza7lstvk/image/upload/v1739544250/User%20Guide/Screenshot_2025-02-14_at_4.43.21_PM_lcm50k.png) + +### JSON Section + +The JSON section is useful for developers to view the raw order data in JSON structure. Developers can use this section to debug and troubleshoot issues related to the order. + +To view the JSON structure, click on the icon. --- -## Sections of the Order Details Page +## Allocate Order Items Manually -### First Section +If Medusa manages the inventory of an ordered item, it reserves or allocates the ordered quantity from the inventory. This ensures that the item's available quantity is reduced by the ordered quantity. -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. +Medusa allocates the ordered quantity from the stock location of the chosen shipping option in the order. For example, if the customer chooses a shipping option that uses a stock location in the US, Medusa allocates the ordered quantity from that stock location. -### Summary +However, in some cases you may need to allocate an item manually, such as if you [edit the order](../edit/page.mdx) if you changed the inventory management configurations of the item's product variant. You'll find next to the item's name in the Summary section a "Not allocated" badge. -This section includes the summary of the items the customer purchased as well as totals related to taxes, shipping, and more. +![Not Allocated Badge](https://res.cloudinary.com/dza7lstvk/image/upload/v1739546156/User%20Guide/Screenshot_2025-02-14_at_5.14.59_PM_fgc2d2.png) -### Customer +To allocate these items manually: -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 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 icon at the top right of the section. -4. Choose "Allocate items" from the dropdown. -5. In the form that opens: +1. Go to the Summary section of the order's details page. +2. If one or more items haven't been allocated, you'll find an "Allocate items" button at the bottom of the section. Click on it. +3. 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. + 2. In the Items to Allocate section, enter the quantity to allocate for each item. +4. Once you're done, click the "Allocate Items" 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 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 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. +![Allocate Items Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739545718/User%20Guide/Screenshot_2025-02-14_at_5.07.46_PM_mzi0bg.png) --- ## 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 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. +3. Click on "Shipping address" from the dropdown. +4. In the side window that opens, update the address details. 5. Once you’re done, click on the Save button. +![Edit Shipping Address Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739546317/User%20Guide/Screenshot_2025-02-14_at_5.18.13_PM_zfi5ly.png) + --- ## 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 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. +3. Click on "Billing address" from the dropdown. +4. In the side window that opens, update the address details. 5. Once you’re done, click on the Save button. +![Edit Billing Address Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739546393/User%20Guide/Screenshot_2025-02-14_at_5.19.43_PM_wzmy8p.png) + --- ## Edit Email Address -{/* TODO check information after #4 */} +You can edit the email address of an order to send order-update notifications to a new email address. This doesn't update the associated customer's address or transfer the order to a new customer. To transfer the order to a new customer, see the [Transfer Customer Ownership](#transfer-customer-ownership) section. To edit the email address associated with an order: 1. Open the order details page. 2. Click on the 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. +3. Click on "Email" from the dropdown. +4. In the side window that opens, edit the email address. 5. Once you’re done, click on the Save button. +![Edit Email Address Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739546558/User%20Guide/Screenshot_2025-02-14_at_5.22.06_PM_fmrnc6.png) + --- ## Transfer Customer Ownership -{/* TODO check information after #4 */} +You can transfer the ownership of an order to another registered customer. This changes the customer associated with the order and sends notifications for order updates to the new customer. -To change the customer that placed this order: + + +You can't transfer ownership to a guest customer, and that includes customers you create through the admin dashboard. + + + +When you transfer the ownership of an order, the original customer will receive a notification, such as an email, requesting their approval for the transfer. The order is transferred to the new customer only after the original customer approves the transfer. + +To transfer the ownership of an order to another customer: 1. Open the order details page. 2. Click on the 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. +4. In the side window that opens, choose the new customer from the dropdown under the "New owner" section. +5. Once done, click on the Save button. ---- +The original customer will then receive a notification requesting their approval for the transfer. -## 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 icon. -3. Once done, click on the icon. - -The note is added and shown in the timeline. - ---- - -## Delete a Note - -{/* TODO check information for correctness */} - - - -Deleting notes is irreversible. - - - -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 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. +![Transfer Ownership Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739546904/User%20Guide/Screenshot_2025-02-14_at_5.28.12_PM_brwpek.png) --- ## Cancel an Order +You can cancel an order if no actions have been performed on it, such as payment captured or items fulfilled. Canceling an order will change its status to canceled and notify the customer about the cancellation. + Canceling an order is irreversible. @@ -225,6 +177,10 @@ Canceling an order is irreversible. To cancel an order: 1. Open the order details page. -2. In the first section showing the order’s number, click on the at the top right. -3. Click on Cancel Order from the dropdown. +2. In the first section showing the order’s number, click on the at its right. +3. Click on Cancel from the dropdown. 4. Confirm canceling the order by clicking the “Continue” button in the pop-up. + +If the order has been paid for or fulfilled, you'll receive an error message preventing you from canceling the order. Otherwise, the order will be canceled. + +![Cancel Order Dropdown](https://res.cloudinary.com/dza7lstvk/image/upload/v1739547244/User%20Guide/Screenshot_2025-02-14_at_5.32.38_PM_urp4yg.png) diff --git a/www/apps/user-guide/app/orders/page.mdx b/www/apps/user-guide/app/orders/page.mdx index ff194c7bce..31b51be90a 100644 --- a/www/apps/user-guide/app/orders/page.mdx +++ b/www/apps/user-guide/app/orders/page.mdx @@ -3,46 +3,33 @@ sidebar_autogenerate_exclude: true --- export const metadata = { - title: `Orders`, + title: `Orders Overview`, } # {metadata.title} -In this document, you’ll get an overview of the orders listing page. +The Orders domain is where you'll manage all the orders in your store coming through different channels. You can view an order’s information, capture payment, create shipments and fulfillments, register returns or exchanges of the order, and more. -## Overview +![Orders List](https://res.cloudinary.com/dza7lstvk/image/upload/v1739542797/User%20Guide/Screenshot_2025-02-14_at_4.19.37_PM_czal8i.png) -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. +You can view the list of available orders in your commerce store by clicking on Orders from the sidebar menu. -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. +In the list, you can see order details such as the ID, date, customer, sales channel, and fulfillment and payment status. You can also search, filter, and sort the orders to find the specific order you are looking for. + + + +Find tips to use lists effectively in [this guide](../tips/lists/page.mdx). + + --- -## 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 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) +- [Manage Order Exchanges](./exchanges/page.mdx) + \ No newline at end of file diff --git a/www/apps/user-guide/app/orders/payments/page.mdx b/www/apps/user-guide/app/orders/payments/page.mdx index 722f7dc013..673861743c 100644 --- a/www/apps/user-guide/app/orders/payments/page.mdx +++ b/www/apps/user-guide/app/orders/payments/page.mdx @@ -6,66 +6,150 @@ sidebar_label: Manage Payments import { EllipsisHorizontal, } from "@medusajs/icons" +import { Table } from "docs-ui" export const metadata = { - title: `Manage Order's Payments`, + title: `Manage Order Payments`, } # {metadata.title} -In this document, you’ll learn how to manage an order’s payment, including capturing and refunding the payment. +In this guide, 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. +When a customer places an order, their payment is authorized by the payment provider they've chosen. You can manage an order's payment by capturing it, refunding it, or handling outstanding amounts. -The payment isn’t automatically captured. You must capture it manually from the Medusa Admin. +### Order Payment Statuses + +At the top of the order details page, you can see the payment status of the order. The payment status can be one of the following: + + + + + Status + Description + + + + + Authorized + The default status when an order is placed, unless the payment provider is configured to automatically capture the payment. + + + Partially Authorized + Part of the payment is authorized, which happens if an order has changed. For example, if an order was edited and new payment is required. + + + Captured + The payment has been captured and processed with the payment provider. + + + Partially Captured + A part of the payment has been captured. This happens when an order's payment was previously captured, but a change to the status, such as an exchange, requires additional payment. + + + Refunded + The payment has been refunded to the customer. + + + Partially Refunded + A part of the payment has been refunded. + + +
--- ## Capture Payment +Unless the payment provider that the customer chose is configured to automatically capture an order's payment, you need to manually capture the payment. + +Capturing an order's payment triggers its processing with the chosen payment provider, such as Stripe. + -Payment is only captured once. +If you're unsure whether your payment provider is configured to automatically capture payments, please contact your technical team. To capture an order’s payment: -1. Open the order details page. +1. Open the order's details page. 2. Scroll to the Payments section. -3. Click on the Capture button. +3. Click on the Capture Payment button. +4. Confirm capturing the payment by clicking the "Confirm" button in the pop-up. + +![Capture Payment Button](https://res.cloudinary.com/dza7lstvk/image/upload/v1739548104/User%20Guide/Screenshot_2025-02-14_at_5.48.04_PM_usm2le.png) --- +## Handling Outstanding Amounts + +After making changes to an order, such as [editing its items](../edit/page.mdx) or [creating an exchange](../exchanges/page.mdx), there may be outstanding amounts (to be captured from the customer or returned) that are in the Summary section. + +![Outstanding amount in Summary](https://res.cloudinary.com/dza7lstvk/image/upload/v1739801684/User%20Guide/Screenshot_2025-02-17_at_4.14.05_PM_qmw7gr.png) + +If the outstanding amount is negative, it means you owe the customer a [refund](#refund-payment). + +Otherwise, a positive outstanding amount means there are additional payments required from the customer. You can handle it by either: + +1. [Mark the order as paid manually](#mark-outstanding-amount-as-paid); +2. Or [copy a payment link](#copy-payment-link-for-additional-payment). + ## Refund Payment +If you've made changes to an order, such as return or exchange items, you can refund a previously-captured payment if there's an outstanding amount. + +Refunding the payment triggers its processing with the chosen payment provider, such as Stripe. + Refunding payments is irreversible. - +To refund an order’s outstanding amount: -Payment can only be refunded if it's captured. +1. Open the order's details page. +2. Scroll to the Payment section. +3. Click on the icon at the right of the payment to refund. +4. Choose "Refund" from the dropdown. +5. In the side window that opens, fill out the following fields: + - **Select payment to refund**: Choose the payment to refund an amount from. + - **Amount**: Enter the amount to refund. + - **Note**: A note that the customer can see in the notification they receive. +6. Once you’re done, click on the Save button. + +Once the payment is refunded, the customer will receive a notification about the refund and you can view the refund as part of the order's activity. + +![Refund Payment Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739550855/User%20Guide/Screenshot_2025-02-14_at_6.34.01_PM_l9evmh.png) + +### Mark Outstanding Amount as Paid + +By marking a positive outstanding amount as paid, you're capturing the payment without processing it through the associated payment provider. Instead, you handle capturing the payment outside of Medusa. + +To mark a positive outstanding amount as paid: + +1. Open the order's details page. +2. In the Summary section, click on the "Mark as paid" button. +3. Confirm marking the payment as paid by clicking the "Confirm" button in the pop-up. + +### Copy Payment Link for Additional Payment + +Another way you can handle a positive outstanding amount is by sharing a payment link with the customer to authorize the payment. The payment link is a link in the storefront that the customer can use to pay for the additional amount. + +To copy a payment link for the additional payment: + +1. Open the order's details page. +2. In the Summary section, click on the "Copy payment link" button. + +The link is then copied and you can share it with the customer to authorize the payment. Once authorized, you can then [capture the payment](../payments/page.mdx#capture-payment). + + + +{/* TODO add link to guide once available */} + +If the payment link doesn't start with a domain or has a domain that doesn't match your storefront, refer your technical team to [this guide](#) to set up the storefront domain. - -{/* 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 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. diff --git a/www/apps/user-guide/app/orders/returns/page.mdx b/www/apps/user-guide/app/orders/returns/page.mdx index 4ff63ec507..f06a6b3309 100644 --- a/www/apps/user-guide/app/orders/returns/page.mdx +++ b/www/apps/user-guide/app/orders/returns/page.mdx @@ -5,26 +5,30 @@ sidebar_label: Manage Returns import { EllipsisHorizontal, + HeartBroken, + PencilSquare } from "@medusajs/icons" export const metadata = { - title: `Manage Order’s Returns`, + title: `Manage Order Returns`, } # {metadata.title} -In this document, you’ll learn more about order returns, how to request a return, and more. +In this guide, you’ll learn about order returns and how to manage them. -## Overview +## Order Returns Overview -Part of the order management system that Medusa provides is automating and managing order returns. +After items have been delivered to the customer, they can return the items for a refund. These items are added back to stock or marked as damaged. -There are two ways order returns can be requested: +![Return requested in Activity section](https://res.cloudinary.com/dza7lstvk/image/upload/v1739794292/User%20Guide/Screenshot_2025-02-17_at_2.11.19_PM_c0fuyr.png) -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. +Medusa allows you to automate the Return Merchandise Authorization (RMA) process by supporting two ways of creating returns: -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. +1. The customer requests a return for an order through the storefront, which you can [view](#find-return-requests-of-an-order) in the Medusa Admin dashboard; +2. Or you can [create a return](#create-an-order-return) and inform the customer about it. + +As an admin user, you can then manage the return to either [cancel it](#cancel-requested-return) or [mark the items as received](#mark-return-items-as-received) and refund the customer. --- @@ -32,81 +36,96 @@ After a return is requested, the admin user chooses to either cancel the return 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. +1. Open the order's details page. +2. In the Activity section, you'll find that a return was requested, which you can manage. + +You'll also find the items requested to be returned in the Summary section, with a note below the items to be returned. + +![Items to be returned in Summary section](https://res.cloudinary.com/dza7lstvk/image/upload/v1739794541/User%20Guide/Screenshot_2025-02-17_at_2.15.01_PM_mskn1o.png) --- -## Request a Return for an Order +## Create an Order Return -{/* TODO check info for correctness */} +You can create a return from the Medusa Admin for [delivered items](../fulfillments/page.mdx#mark-fulfillment-as-delivered) in an order. -To request a return for an order: +To create a return for an order: 1. Open the order details page. -2. In the Timeline section, click on the 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. +2. In the Summary section, click on the icon at the top right. +3. Choose "Create Return" from the dropdown. +4. In the form that opens: + - To add items to return: + - Click on "Add items" in the "Inbound section". + - In the list that opens, click on the checkbox next to the items you want the customer to return. + - Once done, click on the "Save" button. + - You can edit the quantity of the items to return by editing the input next to the inbound item. + - To add a reason for the returned item: + - Click on the icon next to the item. + - Choose "Add Reason" from the dropdown. + - In the Reason select input shown, choose the reason for the return. You can add return reasons in the [Settings](../../settings/return-reasons/page.mdx) to choose from. + - To add a note for the returned item: + - Click on the icon next to the item. + - Choose "Add Note" from the dropdown. + - To remove an inbound item from the return: + - Click on the icon next to the item. + - Choose "Remove" from the dropdown. + - For the Location input, specify the location to return the items to. + - While you can choose a location that the item doesn't have inventory in, later, you can't receive the item unless you [add inventory](../../inventory/inventory/page.mdx) for the item's variant in the chosen location. + - For the "Return shipping" field, you can optionally choose a shipping option to use to return the item, subtracting the shipping cost from the return total, which is refunded to the customer. + - To modify the return shipping's cost: + - Click the icon next to the Return Shipping total. + - Enter the new cost in the input shown. + - If you don’t want the customer to receive a notification that a return has been created, uncheck the “Send notifications” toggle. +5. Once you're done, click the "Confirm Return" button to create the return, then confirm the action by clicking the "Continue" button in the pop-up. + +This creates the return, which you can see in the Summary and Activity sections of the order's details page. + +![Create Return Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739798514/User%20Guide/Screenshot_2025-02-17_at_3.21.34_PM_hxliws.png) --- -## Receive Return +## Mark Return Items as Received + +Once the customer returns the item, you can mark it as received. This triggers a refund to the customer and the non-damaged item quantity is added to the stock quantity in the inventory. + +To mark return items as received: + +1. Open the order's details page. +2. In the Summary section, click on the "Receive items" button. +3. In the side window that opens: + - For each item part of the return: + - Enter the quantity that isn't damaged and can be added back into the stock in the input shown next to the item. + - To add damaged quantity: + - Decrement the quantity that isn't damaged by the damaged amount. + - Click on the button next to the item. + - Enter the damaged quantity. + - To notify the customer that the return is received, check the "Send notifications" toggle. +4. Once done, click on the "Save" button. + +![Mark Received Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739795669/User%20Guide/Screenshot_2025-02-17_at_2.34.13_PM_fkzrdn.png) + +--- + +## Cancel Requested Return + +You can cancel a return, whether requested by the customer or that you created. -Once the return is marked as received, a refund is issued to the customer. +Canceling a return is irreversible. The customer would have to request a new return or you can create a return request. - +To cancel a requested return: -The order's payment must be captured first. - - - -{/* 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. +1. In the Activity section, click on Cancel next to the Return Request item. +2. Confirm the cancellation by clicking on the "Confirm" button in the pop-up. --- -## Cancel a Return +## Refund Customer for a Return - +If a return causes an outstanding amount, you can see it in the Summary section of an order. To learn how to refund the payment, refer to [this guide](../payments/page.mdx#refund-payment). -Canceling a return is irreversible. - - - - - -The return must be [marked as received](#receive-return) first. - - - -{/* 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 icon. -3. Click on “Cancel return” in the dropdown. +![Outstanding amount in summary](https://res.cloudinary.com/dza7lstvk/image/upload/v1739799808/User%20Guide/Screenshot_2025-02-17_at_3.42.49_PM_cjxgpg.png) \ No newline at end of file diff --git a/www/apps/user-guide/generated/edit-dates.mjs b/www/apps/user-guide/generated/edit-dates.mjs index 2e4a14776b..7083a5e500 100644 --- a/www/apps/user-guide/generated/edit-dates.mjs +++ b/www/apps/user-guide/generated/edit-dates.mjs @@ -12,7 +12,7 @@ export const generatedEditDates = { "app/settings/return-reasons/page.mdx": "2024-05-03T17:36:38+03:00", "app/settings/regions/page.mdx": "2024-05-03T17:36:38+03:00", "app/settings/regions/shipping-options/page.mdx": "2024-05-03T17:36:38+03:00", - "app/orders/page.mdx": "2024-05-03T17:36:38+03:00", + "app/orders/page.mdx": "2025-02-17T15:13:42.484Z", "app/settings/users/invites/page.mdx": "2024-05-03T17:36:38+03:00", "app/settings/taxes/page.mdx": "2024-05-03T17:36:38+03:00", "app/settings/developer/page.mdx": "2024-05-03T17:36:38+03:00", @@ -28,7 +28,6 @@ export const generatedEditDates = { "app/settings/locations/page.mdx": "2024-05-03T17:36:38+03:00", "app/settings/developer/api-key-management/page.mdx": "2024-05-03T17:36:38+03:00", "app/products/categories/page.mdx": "2024-05-03T17:36:38+03:00", - "app/orders/exchange/page.mdx": "2024-05-03T17:36:38+03:00", "app/inventory/reservations/page.mdx": "2024-05-03T17:36:38+03:00", "app/settings/developer/api-key-management/sales-channels/page.mdx": "2024-05-03T17:36:38+03:00", "app/products/gift-cards/page.mdx": "2024-05-03T17:36:38+03:00", @@ -42,19 +41,18 @@ export const generatedEditDates = { "app/settings/developer/executions/page.mdx": "2024-05-03T17:36:38+03:00", "app/inventory/inventory/page.mdx": "2024-05-03T17:36:38+03:00", "app/customers/groups/page.mdx": "2024-05-03T17:36:38+03:00", - "app/orders/manage/page.mdx": "2024-05-03T17:36:38+03:00", - "app/orders/returns/page.mdx": "2024-05-03T17:36:38+03:00", - "app/orders/export/page.mdx": "2024-05-03T17:36:38+03:00", + "app/orders/manage/page.mdx": "2025-02-17T10:29:36.199Z", + "app/orders/returns/page.mdx": "2025-02-17T15:10:11.039Z", "app/inventory/page.mdx": "2024-05-03T17:36:38+03:00", "app/settings/sales-channels/manage/page.mdx": "2024-05-03T17:36:38+03:00", - "app/orders/claims/page.mdx": "2024-05-03T17:36:38+03:00", - "app/orders/fulfillments/page.mdx": "2024-05-03T17:36:38+03:00", + "app/orders/claims/page.mdx": "2025-02-17T15:16:27.380Z", + "app/orders/fulfillments/page.mdx": "2025-02-17T15:12:20.431Z", "app/customers/page.mdx": "2024-05-03T17:36:38+03:00", - "app/orders/edit/page.mdx": "2024-05-03T17:36:38+03:00", + "app/orders/edit/page.mdx": "2025-02-17T15:15:53.489Z", "app/products/collections/page.mdx": "2024-05-03T17:36:38+03:00", - "app/orders/drafts/page.mdx": "2024-05-03T17:36:38+03:00", "app/customers/manage/page.mdx": "2024-05-03T17:36:38+03:00", "app/discounts/create/page.mdx": "2024-05-03T17:36:38+03:00", - "app/orders/payments/page.mdx": "2024-05-03T17:36:38+03:00", - "app/discounts/page.mdx": "2024-05-03T17:36:38+03:00" + "app/orders/payments/page.mdx": "2025-02-17T15:10:24.250Z", + "app/discounts/page.mdx": "2024-05-03T17:36:38+03:00", + "app/orders/exchanges/page.mdx": "2025-02-17T15:14:13.676Z" } \ No newline at end of file diff --git a/www/apps/user-guide/generated/sidebar.mjs b/www/apps/user-guide/generated/sidebar.mjs index 0f671eb520..7ad1316618 100644 --- a/www/apps/user-guide/generated/sidebar.mjs +++ b/www/apps/user-guide/generated/sidebar.mjs @@ -15,7 +15,6 @@ export const generatedSidebar = [ "isPathHref": true, "type": "category", "title": "Tips", - "hasTitleStyling": true, "autogenerate_path": "/tips", "children": [ { @@ -51,90 +50,70 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "category", - "path": "/orders", "title": "Orders", - "hasTitleStyling": true, - "autogenerate_path": "/orders", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/orders/manage", + "title": "Overview", + "path": "/orders", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", "title": "Manage Details", - "description": "", + "path": "/orders/manage", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", - "path": "/orders/payments", "title": "Manage Payments", - "description": "", + "path": "/orders/payments", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", - "path": "/orders/fulfillments", "title": "Manage Fulfillments", - "description": "", + "path": "/orders/fulfillments", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", + "title": "Edit Order Items", "path": "/orders/edit", - "title": "Edit an Order’s Items", - "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", - "path": "/orders/drafts", - "title": "Manage Draft Orders", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/orders/returns", "title": "Manage Returns", - "description": "", + "path": "/orders/returns", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", - "path": "/orders/exchange", "title": "Manage Exchanges", - "description": "", + "path": "/orders/exchanges", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", + "title": "Manage Claims", "path": "/orders/claims", - "title": "Manage Order's Claims", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/orders/export", - "title": "Export Orders", - "description": "", "children": [] } ] @@ -145,7 +124,6 @@ export const generatedSidebar = [ "type": "category", "path": "/products", "title": "Products", - "hasTitleStyling": true, "autogenerate_path": "/products", "children": [ { @@ -231,7 +209,6 @@ export const generatedSidebar = [ "type": "category", "path": "/inventory", "title": "Inventory", - "hasTitleStyling": true, "autogenerate_path": "/inventory", "children": [ { @@ -260,7 +237,6 @@ export const generatedSidebar = [ "type": "category", "path": "/customers", "title": "Customers", - "hasTitleStyling": true, "autogenerate_path": "/customers", "children": [ { @@ -289,7 +265,6 @@ export const generatedSidebar = [ "type": "category", "path": "/discounts", "title": "Discounts", - "hasTitleStyling": true, "autogenerate_path": "/discounts", "children": [ { @@ -318,7 +293,6 @@ export const generatedSidebar = [ "type": "category", "path": "/pricing", "title": "Pricing", - "hasTitleStyling": true, "autogenerate_path": "/pricing", "children": [ { @@ -347,7 +321,6 @@ export const generatedSidebar = [ "type": "category", "path": "/settings", "title": "Settings", - "hasTitleStyling": true, "autogenerate_path": "/settings", "children": [ { diff --git a/www/apps/user-guide/sidebar.mjs b/www/apps/user-guide/sidebar.mjs index 1df0f3adc1..048d8655bc 100644 --- a/www/apps/user-guide/sidebar.mjs +++ b/www/apps/user-guide/sidebar.mjs @@ -15,56 +15,88 @@ export const sidebar = sidebarAttachHrefCommonOptions([ { type: "category", title: "Tips", - hasTitleStyling: true, autogenerate_path: "/tips", }, { type: "category", - path: "/orders", title: "Orders", - hasTitleStyling: true, - autogenerate_path: "/orders", + children: [ + { + type: "link", + title: "Overview", + path: "/orders", + }, + { + type: "link", + title: "Manage Details", + path: "/orders/manage", + }, + { + type: "link", + title: "Manage Payments", + path: "/orders/payments", + }, + { + type: "link", + title: "Manage Fulfillments", + path: "/orders/fulfillments", + }, + { + type: "link", + title: "Edit Order Items", + path: "/orders/edit", + }, + { + type: "link", + title: "Manage Returns", + path: "/orders/returns", + }, + { + type: "link", + title: "Manage Exchanges", + path: "/orders/exchanges", + }, + { + type: "link", + title: "Manage Claims", + path: "/orders/claims", + }, + ], }, { type: "category", path: "/products", title: "Products", - hasTitleStyling: true, autogenerate_path: "/products", }, { type: "category", path: "/inventory", title: "Inventory", - hasTitleStyling: true, autogenerate_path: "/inventory", }, { type: "category", path: "/customers", title: "Customers", - hasTitleStyling: true, autogenerate_path: "/customers", }, { type: "category", path: "/discounts", title: "Discounts", - hasTitleStyling: true, autogenerate_path: "/discounts", }, { type: "category", path: "/pricing", title: "Pricing", - hasTitleStyling: true, autogenerate_path: "/pricing", }, { type: "category", path: "/settings", title: "Settings", - hasTitleStyling: true, autogenerate_path: "/settings", }, ])