* initialized next.js project * finished markdown sections * added operation schema component * change page metadata * eslint fixes * fixes related to deployment * added response schema * resolve max stack issue * support for different property types * added support for property types * added loading for components * added more loading * type fixes * added oneOf type * removed console * fix replace with push * refactored everything * use static content for description * fixes and improvements * added code examples section * fix path name * optimizations * fixed tag navigation * add support for admin and store references * general enhancements * optimizations and fixes * fixes and enhancements * added search bar * loading enhancements * added loading * added code blocks * added margin top * add empty response text * fixed oneOf parameters * added path and query parameters * general fixes * added base path env variable * small fix for arrays * enhancements * design enhancements * general enhancements * fix isRequired * added enum values * enhancements * general fixes * general fixes * changed oas generation script * additions to the introduction section * added copy button for code + other enhancements * fix response code block * fix metadata * formatted store introduction * move sidebar logic to Tags component * added test env variables * fix code block bug * added loading animation * added expand param + loading * enhance operation loading * made responsive + improvements * added loading provider * fixed loading * adjustments for small devices * added sidebar label for endpoints * added feedback component * fixed analytics * general fixes * listen to scroll for other headings * added sample env file * update api ref files + support new fields * fix for external docs link * added new sections * fix last item in sidebar not showing * move docs content to www/docs * change redirect url * revert change * resolve build errors * configure rewrites * changed to environment variable url * revert changing environment variable name * add environment variable for API path * fix links * fix tailwind settings * remove vercel file * reconfigured api route * move api page under api * fix page metadata * fix external link in navigation bar * update api spec * updated api specs * fixed google lint error * add max-height on request samples * add padding before loading * fix for one of name * fix undefined types * general fixes * remove response schema example * redesigned navigation bar * redesigned sidebar * fixed up paddings * added feedback component + report issue * fixed up typography, padding, and general styling * redesigned code blocks * optimization * added error timeout * fixes * added indexing with algolia + fixes * fix errors with algolia script * redesign operation sections * fix heading scroll * design fixes * fix padding * fix padding + scroll issues * fix scroll issues * improve scroll performance * fixes for safari * optimization and fixes * fixes to docs + details animation * padding fixes for code block * added tab animation * fixed incorrect link * added selection styling * fix lint errors * redesigned details component * added detailed feedback form * api reference fixes * fix tabs * upgrade + fixes * updated documentation links * optimizations to sidebar items * fix spacing in sidebar item * optimizations and fixes * fix endpoint path styling * remove margin * final fixes * change margin on small devices * generated OAS * fixes for mobile * added feedback modal * optimize dark mode button * fixed color mode useeffect * minimize dom size * use new style system * radius and spacing design system * design fixes * fix eslint errors * added meta files * change cron schedule * fix docusaurus configurations * added operating system to feedback data * change content directory name * fixes to contribution guidelines * revert renaming content * added api-reference to documentation workflow * fixes for search * added dark mode + fixes * oas fixes * handle bugs * added code examples for clients * changed tooltip text * change authentication to card * change page title based on selected section * redesigned mobile navbar * fix icon colors * fix key colors * fix medusa-js installation command * change external regex in algolia * change changeset * fix padding on mobile * fix hydration error * update depedencies
87 lines
3.9 KiB
Plaintext
87 lines
3.9 KiB
Plaintext
---
|
||
sidebar_position: 4
|
||
sidebar_label: Manage Fulfillments
|
||
description: 'This user guide explains how to manage order fulfillments in the Medusa Admin. Learn how to create fulfillments, mark fulfillments as shipped, and cancel fulfillments.'
|
||
addHowToData: true
|
||
---
|
||
|
||
import UiIcon from '@site/src/components/UiIcon';
|
||
|
||
# Manage Order's Fulfillments
|
||
|
||
In this tutorial, you’ll learn about order fulfillments and how to manage them, including how to create fulfillments and mark them as shipped.
|
||
|
||
## Overview
|
||
|
||
When a customer places an order, the fulfillment status of the order will be “not_shipped”. You can then create fulfillments and mark them as shipped once you ship the items.
|
||
|
||
You can create more than one fulfillment, with each fulfillment used for at least one item in the order.
|
||
|
||
If some items of the order are fulfilled, the order’s fulfillment status will be “partially_shipped”. Once all items are shipped, the order’s fulfillment status will be “shipped”.
|
||
|
||
---
|
||
|
||
## Create Fulfillment
|
||
|
||
:::info
|
||
|
||
The steps mentioned here regarding an item's location and quantity are only available if you have the Inventory and Stock Location modules installed. You can learn more in the [Multi-Warehouse documentation](../multiwarehouse/index.md).
|
||
|
||
:::
|
||
|
||
To create a fulfillment for an order:
|
||
|
||
1. Open the order details page.
|
||
2. Scroll down to the Fulfillment section.
|
||
3. Click on the Create Fulfillment button.
|
||
4. In the window that opens:
|
||
- Choose the location you want to fulfill the items from.
|
||
- Under Items to fulfill, enter the quantity of the items you want to fulfill.
|
||
- Optionally enter any additional information you want to associate with the fulfillment under the Metadata section.
|
||
- If you don’t want the customer to receive an email that a fulfillment has been created, uncheck the “Send notifications” checkbox.
|
||
5. Once done, click on the "Create fulfillment" button.
|
||
|
||
You can check the fulfillment details in the Fulfillment and Timeline sections.
|
||
|
||
---
|
||
|
||
## Mark a Fulfillment Shipped
|
||
|
||
:::caution
|
||
|
||
Once a fulfillment is marked as shipped, it can’t be reverted. You must [create a fulfillment](#create-fulfillment) first before you can mark it as shipped.
|
||
|
||
:::
|
||
|
||
To mark a fulfillment as shipped in an order:
|
||
|
||
1. Open the order details page.
|
||
2. Scroll down to the Fulfillment section.
|
||
3. Find the fulfillment you want to mark as shipped, then click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon next to it.
|
||
4. Click on Mark Shipped in the dropdown.
|
||
5. In the new window that opens:
|
||
- Enter a tracking number for the shipment.
|
||
- If you have more than one tracking number, click on the “Add Additional Tracking Number” to add more numbers.
|
||
- If you don’t want the customer to receive an email that the fulfillment has been shipped, uncheck the “Send notifications” checkbox.
|
||
6. Once you’re done, click the Complete button.
|
||
|
||
Shipment details can be seen in the Timeline section.
|
||
|
||
---
|
||
|
||
## Cancel a Fulfillment
|
||
|
||
:::caution
|
||
|
||
If you cancel a fulfillment, it can’t be reverted. Only a fulfillment that hasn’t been marked as shipped can be canceled.
|
||
|
||
:::
|
||
|
||
To cancel a fulfillment in an order:
|
||
|
||
1. Open the order details page.
|
||
2. Scroll down to the Fulfillment section.
|
||
3. Find the fulfillment you want to cancel, then click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon next to it.
|
||
4. Click on Cancel Fulfillment in the dropdown.
|
||
5. Confirm canceling the fulfillment by clicking the “Yes, confirm” button in the pop-up.
|