* 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
188 lines
5.6 KiB
Plaintext
188 lines
5.6 KiB
Plaintext
---
|
||
description: "Multi-warehouse allows merchants to store a product in multiple locations with accurate and consistent inventory data within the commerce application."
|
||
---
|
||
|
||
import DocCardList from '@theme/DocCardList';
|
||
import DocCard from '@theme/DocCard';
|
||
import Icons from '@theme/Icon';
|
||
|
||
# Multi-Warehouse
|
||
|
||
Multi-warehouse allows merchants to store a product in multiple locations with accurate and consistent inventory data within the commerce application.
|
||
|
||
Multi-warehouse in Medusa is composed of two modules: an inventory module - which is the NPM package `@medusajs/inventory` - and a stock location module - which is the NPM package `@medusajs/stock-location`.
|
||
|
||
<DocCard item={{
|
||
type: 'link',
|
||
href: '/modules/multiwarehouse/install-modules',
|
||
label: 'Install Modules',
|
||
customProps: {
|
||
icon: Icons['academic-cap-solid'],
|
||
description: 'Learn how to install the modules related to multi-warehouse',
|
||
}
|
||
}} />
|
||
|
||
You can also create your own modules and use them with the Medusa backend.
|
||
|
||
<DocCardList colSize={6} items={[
|
||
{
|
||
type: 'link',
|
||
href: '/modules/multiwarehouse/backend/create-inventory-service',
|
||
label: 'Backend: Create Inventory Service',
|
||
customProps: {
|
||
icon: Icons['academic-cap-solid'],
|
||
description: 'Learn how to create an inventory service to be used in a custom inventory module.'
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/modules/multiwarehouse/backend/create-stock-location-service',
|
||
label: 'Backend: Create Stock Location Service',
|
||
customProps: {
|
||
icon: Icons['academic-cap-solid'],
|
||
description: 'Learn how to create a stock location service to be used in a custom stock location module.'
|
||
}
|
||
},
|
||
]} />
|
||
|
||
---
|
||
|
||
## Features
|
||
|
||
### Multiple Stock Locations
|
||
|
||
Admins can manage the stock locations, which are the places they store their products. Stock locations are associated with different sales channels.
|
||
|
||
<DocCardList colSize={6} items={[
|
||
{
|
||
type: 'link',
|
||
href: '/user-guide/multiwarehouse/locations',
|
||
label: 'User Guide: Manage Stock Locations',
|
||
customProps: {
|
||
icon: Icons['users-solid'],
|
||
description: 'Learn how to manage stock locations in Medusa admin.'
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/modules/multiwarehouse/admin/manage-stock-locations',
|
||
label: 'Admin: Manage Stock Locations',
|
||
customProps: {
|
||
icon: Icons['academic-cap-solid'],
|
||
description: 'Learn how to manage stock locations using admin APIs.',
|
||
}
|
||
},
|
||
]} />
|
||
|
||
### Inventory Management Across Locations
|
||
|
||
Admins can manage the inventory of product variants across the different stock locations.
|
||
|
||
<DocCardList colSize={6} items={[
|
||
{
|
||
type: 'link',
|
||
href: '/user-guide/multiwarehouse/inventory',
|
||
label: 'User Guide: Manage Inventory',
|
||
customProps: {
|
||
icon: Icons['users-solid'],
|
||
description: 'Learn how to manage inventory using the Medusa admin.'
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/modules/multiwarehouse/admin/manage-inventory-items',
|
||
label: 'Admin: Manage Inventory',
|
||
customProps: {
|
||
icon: Icons['academic-cap-solid'],
|
||
description: 'Learn how to manage inventory using the admin APIs.',
|
||
}
|
||
},
|
||
]} />
|
||
|
||
### Manage Item Allocations in Orders
|
||
|
||
Admins can manage item allocations to choose which stock location to fulfill items from or return items to. Item quantities are reserved in a stock location until the item is fulfilled to ensure data consistency.
|
||
|
||
<DocCardList colSize={6} items={[
|
||
{
|
||
type: 'link',
|
||
href: '/user-guide/orders/manage#manage-item-allocation',
|
||
label: 'User Guide: Manage Allocations in Orders',
|
||
customProps: {
|
||
icon: Icons['users-solid'],
|
||
description: 'Learn how to manage allocations of items in an order using the Medusa admin.'
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/modules/multiwarehouse/admin/manage-item-allocations-in-orders',
|
||
label: 'Admin: Manage Allocations in Orders',
|
||
customProps: {
|
||
icon: Icons['academic-cap-solid'],
|
||
description: 'Learn how to manage allocations of items in an order using the admin APIs.',
|
||
}
|
||
},
|
||
]} />
|
||
|
||
---
|
||
|
||
## Understanding the Architecture
|
||
|
||
The commerce modules automatically detect whether a product variant is in stock, decrement the variant’s stock on fulfillment, and increment the variant’s stock on returns.
|
||
|
||
<DocCardList colSize={6} items={[
|
||
{
|
||
type: 'link',
|
||
href: '/modules/multiwarehouse/inventory-module',
|
||
label: 'Architecture: Inventory Module',
|
||
customProps: {
|
||
icon: Icons['circle-stack-solid'],
|
||
description: 'Learn about the Inventory Module and how it works.'
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/modules/multiwarehouse/stock-location-module',
|
||
label: 'Architecture: Stock Location Module',
|
||
customProps: {
|
||
icon: Icons['circle-stack-solid'],
|
||
description: 'Learn about the Stock Location Module and how it works.'
|
||
}
|
||
},
|
||
]} />
|
||
|
||
---
|
||
|
||
## Related Modules
|
||
|
||
Discover Multi-warehouse’s relation to other modules in Medusa.
|
||
|
||
<DocCardList colSize={4} items={[
|
||
{
|
||
type: 'link',
|
||
href: '/modules/products/overview',
|
||
label: 'Products',
|
||
customProps: {
|
||
icon: Icons['tag-solid'],
|
||
description: 'Manage the inventory of product variants across locations.',
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/modules/sales-channels/overview',
|
||
label: 'Sales Channels',
|
||
customProps: {
|
||
icon: Icons['channels-solid'],
|
||
description: 'Stock locations are associated with sales channels.',
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/modules/orders/overview',
|
||
label: 'Orders',
|
||
customProps: {
|
||
icon: Icons['check-circle-solid'],
|
||
description: 'Change available stock based on returns and fulfillment.',
|
||
}
|
||
},
|
||
]} /> |