bb87db8342
This PR includes documentation that preps for v2 docs (but doesn't introduce new docs). _Note: The number of file changes in the PR is due to find-and-replace within the `references` which is unavoidable. Let me know if I should move it to another PR._ ## Changes - Change Medusa version in base OAS used for v2. - Fix to docblock generator related to not catching all path parameters. - Added typedoc plugin that generates ER Diagrams, which will be used specifically for data model references in commerce modules. - Changed OAS tool to output references in `www/apps/api-reference/specs-v2` directory when the `--v2` option is used. - Added a version switcher to the API reference to switch between V1 and V2. This switcher is enabled by an environment variable, so it won't be visible/usable at the moment. - Upgraded docusaurus to v3.0.1 - Added new Vale rules to ensure correct spelling of Medusa Admin and module names. - Added new components to the `docs-ui` package that will be used in future documentation changes.
2.3 KiB
description
| description |
|---|
| In this document, you’ll learn how to install multi-warehouse related modules using NPM in the Medusa backend. |
Install Multi-Warehouse Modules
In this document, you’ll learn how to install multi-warehouse related modules using NPM in the Medusa backend.
:::tip
You can also install these modules in any NPM project.
:::
Inventory Module
Step 1: Install Inventory Module
To install the Inventory Module, run the following command in the root directory of the Medusa backend:
npm install @medusajs/inventory
Step 2: Add Inventory Module to Configurations
In medusa-config.js, add the Inventory Module to the exported object under the modules property:
module.exports = {
// ...
modules: {
// ...
inventoryService: {
resolve: "@medusajs/inventory",
},
},
}
Step 3: Run Migrations of Inventory Module
Run the following command to reflect schema changes into your database:
npx medusa migrations run
Step 4: Run Migration Script
After installing the Stock Location Module, make sure to run the migration script
Stock Location Module
Step 1: Install Stock Location Module
To install the Stock Location Module, run the following command in the root directory of the Medusa backend:
npm install @medusajs/stock-location
Step 2: Add Stock Location Module to Configurations
In medusa-config.js, add the Stock Location Module to the exported object under the modules property:
module.exports = {
// ...
modules: {
// ...
stockLocationService: {
resolve: "@medusajs/stock-location",
},
},
}
Step 3: Run Migrations of Stock Location Module
Run the following command to reflect schema changes into your database:
npx medusa migrations run
Step 4: Run Migration Script
After installing both modules, make sure to run the migration script
Run Migration Script
After installing both modules, run the following command to migrate current product variant information to fit the schema changes introduced by the modules:
node ./node_modules/@medusajs/medusa/dist/scripts/migrate-inventory-items.js
You can now start the Medusa backend and use the Stock Location Module in your commerce application.