Install Inventory Management

Inventory Management modules provide all inventory features and options for Single and Multi Source merchants to manage product quantities and stock for sales channels. These features are available in 2.3.x Magento Open Source, Magento Commerce, and Magento Commerce Cloud.

These features and extensions were developed as part of the Magento Inventory (MSI) project through the Magento Community Engineering program.

Inventory Management installs with Magento Magento Open Source and Magento Commerce with all features enabled by default. No additional steps are required for enabling these inventory features. Upgrades from v2.1.x or 2.2.x may require additional steps. See Upgrade Inventory Management.

We recommend installing according to Install Magento Using Composer. You must install with a metapackage to receive all Inventory Management modules.

The following line in the composer.json metapackage installs Inventory Management:

1
        magento/inventory-composer-metapackage = 1.1.3

For a list of Inventory Management metapackage versions, see the release notes.

The Inventory Management installation process adds all modules to the <Magento_installation_directory>/app/etc/config.php file. A 1 value indicates the corresponding module is enabled. The following list of modules are added:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
        'Magento_Inventory' => 1,
        'Magento_InventoryAdminUi' => 1,
        'Magento_InventoryAdvancedCheckout' => 1,
        'Magento_InventoryApi' => 1,
        'Magento_InventoryBundleProduct' => 1,
        'Magento_InventoryBundleProductAdminUi' => 1,
        'Magento_InventoryCatalog' => 1,
        'Magento_InventorySales' => 1,
        'Magento_InventoryCatalogAdminUi' => 1,
        'Magento_InventoryCatalogApi' => 1,
        'Magento_InventoryCatalogSearch' => 1,
        'Magento_InventoryConfigurableProduct' => 1,
        'Magento_InventoryConfigurableProductAdminUi' => 1,
        'Magento_InventoryConfigurableProductIndexer' => 1,
        'Magento_InventoryConfiguration' => 1,
        'Magento_InventoryConfigurationApi' => 1,
        'Magento_InventoryDistanceBasedSourceSelection' => 1,
        'Magento_InventoryDistanceBasedSourceSelectionAdminUi' => 1,
        'Magento_InventoryDistanceBasedSourceSelectionApi' => 1,
        'Magento_InventoryElasticsearch' => 1,
        'Magento_InventoryExportStockApi' => 1,
        'Magento_InventoryIndexer' => 1,
        'Magento_InventorySalesApi' => 1,
        'Magento_InventoryGroupedProduct' => 1,
        'Magento_InventoryGroupedProductAdminUi' => 1,
        'Magento_InventoryGroupedProductIndexer' => 1,
        'Magento_InventoryImportExport' => 1,
        'Magento_InventoryCache' => 1,
        'Magento_InventoryLowQuantityNotification' => 1,
        'Magento_InventoryLowQuantityNotificationApi' => 1,
        'Magento_InventoryMultiDimensionalIndexerApi' => 1,
        'Magento_InventoryProductAlert' => 1,
        'Magento_InventoryRequisitionList' => 1,
        'Magento_InventoryReservations' => 1,
        'Magento_InventoryReservationCli' => 1,
        'Magento_InventoryReservationsApi' => 1,
        'Magento_InventoryExportStock' => 1,
        'Magento_InventorySalesAdminUi' => 1,
        'Magento_InventorySalesFrontendUi' => 1,
        'Magento_InventorySetupFixtureGenerator' => 1,
        'Magento_InventoryShipping' => 1,
        'Magento_InventorySourceDeductionApi' => 1,
        'Magento_InventorySourceSelection' => 1,
        'Magento_InventorySourceSelectionApi' => 1,
        'Magento_InventoryLowQuantityNotificationAdminUi' => 1,
        'Magento_InventoryShippingAdminUi' => 1,
        'Magento_InventoryGraphQl' => 1,

Enable Inventory Management features

When installed, upgraded, or updated, the Manage Stock option in the Admin enables by default. This option enables inventory tracking and management, but does not affect module status. To disable modules, see the next section.

For more information on configurations, see Enabling Inventory Management in the Magento 2 User Guide.

Disable Inventory Management

You may need to disable Inventory Management modules to:

  • Speed up the upgrade process for merchants migrating from 2.0.x, 2.1.x, 2.2.x, or 2.3.x to 2.4.x.
  • Use custom or third-party inventory and Order Management System (OMS) modules.
  • Use OMS for inventory and order management. The current OMS Connector does not support Inventory Management interfaces. We plan to support this integration in a later release.

See the Enable or disable modules topic, specifically the Module status and Module enable, disable sections, for information about how to disable the applicable modules.

When complete, you should a list of modules and values in <Magento_installation_directory>/app/etc/config.php, beginning with:

1
2
3
4
   'Magento_Inventory' => 0,
   'Magento_InventoryAdminUi' => 0,
   'Magento_InventoryAdvancedCheckout' => 0,
   ...

If you have the OMS Connector modules installed, ensure you do not disable the Magento_InventoryMessageBus module. It’s a Connector module, not an MSI one, and you need it to use the Connector with OMS.

Upgrade Inventory Management

Previous Magento versions

When upgrading or updating an existing 2.1.x, 2.2.x, or 2.3.x Magento installation to Magento Magento Open Source or Magento Commerce 2.4.x, Inventory Management modules will be disabled by default. This is a precaution to prevent backward incompatible upgrades and to better support Magento Order Management (OMS).

Currently, Order Management does not support Inventory Management (future development planned). When upgrading, Inventory Management modules will be disabled to allow OMS and Magento 2.3.x to work seamlessly.

To enable Inventory Management modules:

  1. Edit the <Magento_installation_directory>/app/etc/config.php file.
  2. Modify all Inventory modules from 0 to 1 to enable.
  3. Update the database:

    1
    
    bin/magento setup:upgrade
    
  4. Clean the cache:

    1
    
    bin/magento cache:clean
    

We also recommend using reservation inconsistencies commands after upgrading. When upgrading, all of your products will be added to the Default Stock. If you have pending orders, the commands correctly update your salable quantity and reservations for sales and order fulfillment.

Previous Inventory Management versions

When upgrading from previous releases of Inventory Management to the latest version, follow normal extension upgrade steps.

For the latest, update your metapackage version:

1
        magento/inventory-composer-metapackage = 1.1.3

See the following guides for more information on upgrades:

Additional information

See the following guides for more information on Inventory Management: