From a9e3c5e68a913089aef249ed85ff3d897723d4b5 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Tue, 13 Sep 2022 17:47:41 +0300 Subject: [PATCH] docs: added user guide for draft orders (#2198) --- docs/content/user-guide/orders/drafts.md | 11 -- docs/content/user-guide/orders/drafts.mdx | 127 ++++++++++++++++++ .../{fulfillments.md => fulfillments.mdx} | 14 +- docs/content/user-guide/orders/index.md | 10 +- docs/content/user-guide/orders/manage.mdx | 12 ++ docs/content/user-guide/orders/payments.md | 4 + 6 files changed, 162 insertions(+), 16 deletions(-) delete mode 100644 docs/content/user-guide/orders/drafts.md create mode 100644 docs/content/user-guide/orders/drafts.mdx rename docs/content/user-guide/orders/{fulfillments.md => fulfillments.mdx} (80%) diff --git a/docs/content/user-guide/orders/drafts.md b/docs/content/user-guide/orders/drafts.md deleted file mode 100644 index a81db79290..0000000000 --- a/docs/content/user-guide/orders/drafts.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Manage Draft Orders - -:::note - -This guide is coming soon. - -::: diff --git a/docs/content/user-guide/orders/drafts.mdx b/docs/content/user-guide/orders/drafts.mdx new file mode 100644 index 0000000000..ff3c3099f4 --- /dev/null +++ b/docs/content/user-guide/orders/drafts.mdx @@ -0,0 +1,127 @@ +--- +sidebar_position: 5 +--- + +import UiIcon from '@site/src/components/UiIcon'; + +# Manage Draft Orders + +In this document, you’ll learn more about draft orders, how to create them, and more. + +## Overview + +Draft orders are orders created from the Medusa admin. Existing products or custom items can be added to the order as purchased items. You can also specify custom shipping amounts. + +After a draft order is created and is marked as paid, an order will be created based on that draft order and it will appear as part of the Orders list. + +--- + +## Create a Draft Order + +To create a draft order: + +1. Go to Orders → Drafts. +2. Click on “Create draft order” at the top right. +3. A new window then opens with six steps to go through to create the draft order: + 1. In the first step, choose the region this draft order belongs to, then click the Next button. + 2. In the second step, add items to the order. You must add at least one item. Once you’re done, click the Next button. + 1. To add existing products: + 1. Click on the Add Existing button. + 2. Choose the products you want to add into the draft order by clicking the checkbox at the left of the product. You can choose more than one product. + 3. Once done, click on the Add button. + 2. To add a custom item: + 1. Click on the Add Custom button. + 2. Enter the title, price, and quantity of the custom item. + 3. Click on the Add button. + 3. To remove an item you added, click on the icon at the right of the item. + 4. To change the quantity of any item, use the and icons under the Quantity column. + 5. Once you’re done, click the Next button. + 3. In the third step, choose a shipping method then click the Next button. + 1. If you want to change the default price of the shipping method, click on the “Set custom price” button and enter the price you want to use. + 2. If you want to remove the custom price, you can click on the icon. + 4. In the fourth step, enter the customer’s details and shipping address. + 1. If the customer already exists, you can choose it from the first input. You can search the list of customers by name or email. This fills out the fields under the General section as well. + 2. If this is a new customer, in the first field, enter the email of the customer to add. Then, fill out the customer’s first name, last name, and phone number in the General section. + 3. In the Shipping Address section, enter the customer’s address details such as the Address line, postal code, and more. + 4. Once you’re done, click on the Next button. + 5. In the fifth step, specify the billing address details. + 1. If the billing address is the same as the shipping address, you can just check the “Use same as shipping” checkbox. + 2. If the billing address is different than the shipping address, fill out the information under the General and Billing Address as instructed in the previous step. + 3. Once done, click the Next button. + 6. In the last step, confirm that all the information is correct. + 1. If you want to add a discount, click on the Add Discount button and enter the discount code. + 2. If you want to edit any of the draft order’s info, click on the Edit link next to any of the sections. This will take you back to the step associated with that section. +4. Once you’re done following all the six steps, click on the Submit button. + +--- + +## Open Draft Order’s Details + +To open a draft order’s details page: + +1. Go to Orders → Drafts. +2. Select the draft order you want to view. + +--- + +## Edit Draft Order Info + +### Edit Shipping Address + +To edit the shipping address of a draft order: + +1. Open the draft order details page. +2. Scroll down to the customer section and click on the icon in that section. +3. Click on Edit Shipping Address in the dropdown. +4. This opens a new window to edit the shipping address’s info. +5. Once you’re done click on the Save button. + +--- + +## Cancel Draft Order + +:::warning + +Canceling a draft order cannot be undone and the draft order will be removed from the list of draft orders. + +::: + +To cancel a draft order: + +1. Open the draft order details page. +2. Click on the icon at the top right. +3. Click on Cancel Draft Order in the dropdown. +4. Confirm canceling the draft order by clicking the “Yes, remove” button in the pop-up. + +--- + +## Mark Draft Order as Paid + +:::caution + +💡 When you mark a draft order as paid, a new order is created and associated with this draft order. This can’t be undone, but the new order created can be canceled. + +::: + +To mark a draft order as paid: + +1. Open the draft order details page. +2. Scroll down to the Payment section. +3. Click on the “Mark as paid” button. + +You should see a new order in the Orders list now. + +--- + +## Go to Associated Order + +:::info + +This is only available after a draft order is marked as paid. + +::: + +To go to the order associated with the draft order. + +1. Open the draft order details page. +2. Click on the “Go to Order” button at the top right. \ No newline at end of file diff --git a/docs/content/user-guide/orders/fulfillments.md b/docs/content/user-guide/orders/fulfillments.mdx similarity index 80% rename from docs/content/user-guide/orders/fulfillments.md rename to docs/content/user-guide/orders/fulfillments.mdx index 67573f5939..a960376887 100644 --- a/docs/content/user-guide/orders/fulfillments.md +++ b/docs/content/user-guide/orders/fulfillments.mdx @@ -3,6 +3,8 @@ sidebar_position: 4 sidebar_label: Manage Fulfillments --- +import UiIcon from '@site/src/components/UiIcon'; + # Manage Order's Fulfillments In this tutorial, you’ll learn about order fulfillments and how to manage them, including how to create fulfillments and mark them as shipped. @@ -15,6 +17,8 @@ You can create more than one fulfillment, with each fulfillment used for at leas If some items of the order are fulfilled, the order’s fulfillment status will be “partially_shipped”. Once all items are shipped, the order’s fulfillment status will be “shipped”. +--- + ## Create Fulfillment :::info @@ -29,13 +33,15 @@ To create a fulfillment for an order: 2. Scroll down to the Fulfillment section. 3. Click on the Create Fulfillment button. 4. In the window that opens: - - Choose the items you want to create the fulfillment for. These are the items you’ll ship together. You can also choose a specific quantity of an item to ship using the plus and minus icons under the Quantity column. + - Choose the items you want to create the fulfillment for. These are the items you’ll ship together. You can also choose a specific quantity of an item to ship using the and icons under the Quantity column. - Optionally enter any additional information you want to associate with the fulfillment under the Metadata section. - If you don’t want the customer to receive an email that a fulfillment has been created, uncheck the “Send notifications” checkbox. 5. Once done, click on the Complete button. You can check the fulfillment details in the Fulfillment and Timeline sections. +--- + ## Mark a Fulfillment Shipped :::caution @@ -48,7 +54,7 @@ To mark a fulfillment as shipped in an order: 1. Open the order details page. 2. Scroll down to the Fulfillment section. -3. Find the fulfillment you want to mark as shipped, then click on the three dots icon next to it. +3. Find the fulfillment you want to mark as shipped, then click on the icon next to it. 4. Click on Mark Shipped in the dropdown. 5. In the new window that opens: - Enter a tracking number for the shipment. @@ -58,6 +64,8 @@ To mark a fulfillment as shipped in an order: Shipment details can be seen in the Timeline section. +--- + ## Cancel a Fulfillment :::caution @@ -70,6 +78,6 @@ To cancel a fulfillment in an order: 1. Open the order details page. 2. Scroll down to the Fulfillment section. -3. Find the fulfillment you want to cancel, then click on the three dots icon next to it. +3. Find the fulfillment you want to cancel, then click on the icon next to it. 4. Click on Cancel Fulfillment in the dropdown. 5. Confirm canceling the fulfillment by clicking the “Yes, confirm” button in the pop-up. diff --git a/docs/content/user-guide/orders/index.md b/docs/content/user-guide/orders/index.md index 89f0d32f10..f6b79b13cb 100644 --- a/docs/content/user-guide/orders/index.md +++ b/docs/content/user-guide/orders/index.md @@ -13,24 +13,30 @@ When customers buy one or more products, their order appears on the Orders page. The Orders domain also contains draft orders. Draft orders are orders that you create from the Medusa admin. After you fill out the order and mark it paid, it’s transformed into an order that appears as part of the Orders list. +--- + ## View List of Orders You can view the list of available orders in your ecommerce store by clicking on Orders from the sidebar menu. In the list, you can see order details such as the ID, date, customer, fulfillment and payment status, total, and the country of the shipping address. +--- + ## View List of Draft Orders You can view the list of draft orders on the Orders page by clicking on the grey Drafts headline next to the Orders headline. In the list, you can see order details such as ID, the ID of the order the draft order belongs to, the date, the customer, and the status of the draft order. +--- + ## Learn More About Orders - [Manage Order Details](./manage.mdx) - [Manage Order’s Payment](./payments.md) -- [Manage Order’s Fulfillment](./fulfillments.md) -- [Manage Draft Orders](./drafts.md) +- [Manage Order’s Fulfillment](./fulfillments.mdx) +- [Manage Draft Orders](./drafts.mdx) - [Manage Order Returns](./returns.md) - [Manage Order Claims](./claims.md) - [Manage Order Exchanges and Swaps](./swaps.md) diff --git a/docs/content/user-guide/orders/manage.mdx b/docs/content/user-guide/orders/manage.mdx index 534328526a..179ea74f26 100644 --- a/docs/content/user-guide/orders/manage.mdx +++ b/docs/content/user-guide/orders/manage.mdx @@ -18,6 +18,8 @@ To open an order’s details: This opens the order’s details page. +--- + ## Sections of the Order Details Page ### Order Summary @@ -44,6 +46,8 @@ This section includes details related to the shipping method and fulfillment and This section includes the customer’s details, including their shipping address. +--- + ## Edit the Shipping Address To edit the shipping address used for an order: @@ -55,6 +59,8 @@ To edit the shipping address used for an order: 5. This opens a new window to edit the shipping address. 6. Once you’re done, click on the Save button. +--- + ## Edit Email Address To edit the email address associated with an order: @@ -66,6 +72,8 @@ To edit the email address associated with an order: 5. This opens a new window to edit the email address. 6. Once you’re done, click on the Save button. +--- + ## Add a Note To add a note to an order: @@ -76,6 +84,8 @@ To add a note to an order: The note will be added and can be seen in the timeline. +--- + ## Delete a Note :::caution @@ -92,6 +102,8 @@ To delete a note in an order: 4. Click on Delete from the dropdown. 5. Confirm deleting the note by clicking the “Yes, delete” button in the pop-up. +--- + ## Cancel an Order :::warning diff --git a/docs/content/user-guide/orders/payments.md b/docs/content/user-guide/orders/payments.md index 326cddc005..55acbb2af8 100644 --- a/docs/content/user-guide/orders/payments.md +++ b/docs/content/user-guide/orders/payments.md @@ -13,6 +13,8 @@ When a customer places an order, using the payment provider they choose during c The payment isn’t automatically captured. You must capture it manually from the Medusa admin. +--- + ## Capture Payment :::info @@ -27,6 +29,8 @@ To capture an order’s payment: 2. Scroll to the Payment section. 3. Click on the Capture Payment button. +--- + ## Refund Payment :::caution