From 99b51a90b7422e75e6cd324b2e7a9fa7c1756c8e Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Tue, 13 Sep 2022 16:31:43 +0300 Subject: [PATCH] docs: added "Manage Order's Fulfillments" user guide (#2196) --- .../content/user-guide/orders/fulfillments.md | 70 ++++++++++++++++++- docs/content/user-guide/orders/index.md | 1 + docs/content/user-guide/orders/manage.mdx | 1 + docs/content/user-guide/orders/payments.md | 1 + 4 files changed, 70 insertions(+), 3 deletions(-) diff --git a/docs/content/user-guide/orders/fulfillments.md b/docs/content/user-guide/orders/fulfillments.md index b383547471..67573f5939 100644 --- a/docs/content/user-guide/orders/fulfillments.md +++ b/docs/content/user-guide/orders/fulfillments.md @@ -1,11 +1,75 @@ --- sidebar_position: 4 +sidebar_label: Manage Fulfillments --- -# Manage Fulfillments +# Manage Order's Fulfillments -:::note +In this tutorial, you’ll learn about order fulfillments and how to manage them, including how to create fulfillments and mark them as shipped. -This guide is coming soon. +## Overview + +When a customer places an order, the fulfillment status of the order will be “not_shipped”. You can then create fulfillments and mark them as shipped once you ship the items. + +You can create more than one fulfillment, with each fulfillment used for at least one item in the order. + +If some items of the order are fulfilled, the order’s fulfillment status will be “partially_shipped”. Once all items are shipped, the order’s fulfillment status will be “shipped”. + +## Create Fulfillment + +:::info + +You can only create a fulfillment in an order while there are items in the order that haven’t been shipped. ::: + +To create a fulfillment for an order: + +1. Open the order details page. +2. Scroll down to the Fulfillment section. +3. Click on the Create Fulfillment button. +4. In the window that opens: + - Choose the 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. + - 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 + +You must [create a fulfillment](#create-fulfillment) first before you can mark it as shipped. Once a fulfillment is marked as shipped, it can’t be reverted. + +::: + +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. +4. Click on Mark Shipped in the dropdown. +5. In the new window that opens: + - Enter a tracking number for the shipment. + - If you have more than one tracking number, click on the “Add Additional Tracking Number” to add more numbers. + - If you don’t want the customer to receive an email that the fulfillment has been shipped, uncheck the “Send notifications” checkbox. +6. Once you’re done, click the Complete button. + +Shipment details can be seen in the Timeline section. + +## Cancel a Fulfillment + +:::caution + +Only a fulfillment that hasn’t been marked as shipped can be canceled. If you cancel a fulfillment, it can’t be reverted. + +::: + +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. +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 44e1bdfaf3..89f0d32f10 100644 --- a/docs/content/user-guide/orders/index.md +++ b/docs/content/user-guide/orders/index.md @@ -1,5 +1,6 @@ --- sidebar_position: 1 +sidebar_label: Overview --- # Orders Overview diff --git a/docs/content/user-guide/orders/manage.mdx b/docs/content/user-guide/orders/manage.mdx index 6fa520b55c..534328526a 100644 --- a/docs/content/user-guide/orders/manage.mdx +++ b/docs/content/user-guide/orders/manage.mdx @@ -1,5 +1,6 @@ --- sidebar_position: 2 +sidebar_label: Manage Details --- import UiIcon from '@site/src/components/UiIcon'; diff --git a/docs/content/user-guide/orders/payments.md b/docs/content/user-guide/orders/payments.md index 0e9ec3f87a..326cddc005 100644 --- a/docs/content/user-guide/orders/payments.md +++ b/docs/content/user-guide/orders/payments.md @@ -1,5 +1,6 @@ --- sidebar_position: 3 +sidebar_label: Manage Payments --- # Manage Order's Payments