Install the Inventory Management feature

Last updated:
Edit on GitHub
You are browsing a previous version of the document. The latest version is 202307.0.

This document describes how to ingrate the Inventory Management feature into a Spryker project.

The following feature integration guide expects the basic feature to be in place.

The current feature integration guide adds the following functionality:

Install feature core

Follow the steps below to install the Inventory Management feature core.

Prerequisites

Install the required features:

NAME VERSION
Spryker Core 202204.0

1) Install the required modules using Composer

Run the following command to install the required modules:

composer require spryker-feature/inventory-management:"202204.0" --update-with-dependencies
Verification

Make sure that the following modules have been installed:

MODULE EXPECTED DIRECTORY
Stock vendor/spryker/stock
StockDataImport vendor/spryker/stock-data-import
StockGui vendor/spryker/stock-gui
StockAddress vendor/spryker/stock-address
StockAddressDataImport vendor/spryker/stock-address-data-import

2) Set up database schema and transfer objects

Set up database schema and transfer objects:

  1. Adjust the schema definition so EventTransfer has the additional columns for the Availability entity:

src/Pyz/Zed/Availability/Persistence/Propel/Schema/spy_availability.schema.xml

<?xml version="1.0"?>
<database xmlns="spryker:schema-01" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="zed" xsi:schemaLocation="spryker:schema-01 https://static.spryker.com/schema-01.xsd" namespace="Orm\Zed\Availability\Persistence" package="src.Orm.Zed.Availability.Persistence">

    <table name="spy_availability_abstract">
        <behavior name="event">
            <parameter name="spy_availability_abstract_quantity" column="quantity" value="0" operator="==="/>
        </behavior>
    </table>

    <table name="spy_availability">
        <behavior name="event">
            <parameter name="spy_availability_is_never_out_of_stock" column="is_never_out_of_stock"/>
            <parameter name="spy_availability_quantity" column="quantity"/>
            <parameter name="spy_availability_sku" column="sku" keep-additional="true"/>
        </behavior>
    </table>
</database>
  1. Configure the full import list:

Zed/DataImport/DataImportConfig.php

<?php

namespace Pyz\Zed\DataImport;

use Spryker\Zed\DataImport\DataImportConfig as SprykerDataImportConfig;
use Spryker\Zed\StockAddressDataImport\StockAddressDataImportConfig;

class DataImportConfig extends SprykerDataImportConfig
{

    /**
     * @return string[]
     */
    public function getFullImportTypes(): array
    {
        $customImportTypes = [
        	StockDataImportConfig::IMPORT_TYPE_STOCK,
            StockDataImportConfig::IMPORT_TYPE_STOCK_STORE,
            StockAddressDataImportConfig::IMPORT_TYPE_STOCK_ADDRESS,
        ];

        return array_merge(parent::getFullImportTypes(), $customImportTypes);
    }
}
  1. Generate transfer changes:
console propel:install
console transfer:generate
Verification

Make sure that the following changes have been applied in transfer objects:

TRANSFER TYPE EVENT PATH
StockTransfer class added src/Generated/Shared/Transfer/StockTransfer.php
StockCriteriaFilterTransfer class added src/Generated/Shared/Transfer/StockCriteriaFilterTransfer.php
StockResponseTransfer class added src/Generated/Shared/Transfer/StockResponseTransfer.php
StockAddressTransfer class added src/Generated/Shared/Transfer/StockAddressTransfer.php
Verification

Make sure that the following changes have been applied in the database:

DATABASE ENTITY TYPE EVENT
spy_stock_store table added
spy_stock.is_active column added
spy_stock_address table created
Verification

Make sure that propel entities have been generated:

FILE PATH EXTENDS
src/Orm/Zed/StockAddress/Persistence/Base/SpyStockAddress.php Spryker/Zed/StockAddress/Persistence/Propel/AbstractSpyStockAddress.php
src/Orm/Zed/StockAddress/Persistence/Base/SpyStockAddressQuery.php Spryker/Zed/StockAddress/Persistence/Propel/AbstractSpyStockAddressQuery.php
Verification

Make sure that SpyAvailabilityTableMap::getBehaviors() provides mapping for spy_availability_is_never_out_of_stock, spy_availability_quantity, and spy_availability_sku.

3) Configure export to Elasticsearch

This section is only related to the integration of the Add to cart from catalog page functionality.

Install the following plugins:

PLUGIN SPECIFICATION PREREQUISITES NAMESPACE
AvailabilityProductAbstractAddToCartPlugin Filters out the products that are not available. Spryker\Zed\Availability\Communication\Plugin\ProductPageSearch

src/Pyz/Zed/ProductPageSearch/ProductPageSearchDependencyProvider.php

<?php

namespace Pyz\Zed\ProductPageSearch;

use Spryker\Zed\Availability\Communication\Plugin\ProductPageSearch\AvailabilityProductAbstractAddToCartPlugin;
use Spryker\Zed\ProductPageSearch\ProductPageSearchDependencyProvider as SprykerProductPageSearchDependencyProvider;

class ProductPageSearchDependencyProvider extends SprykerProductPageSearchDependencyProvider
{
    /**
     * @return \Spryker\Zed\ProductPageSearchExtension\Dependency\Plugin\ProductAbstractAddToCartPluginInterface[]
     */
    protected function getProductAbstractAddToCartPlugins(): array
    {
        return [
            new AvailabilityProductAbstractAddToCartPlugin(),
        ];
    }
}
Verification

Make sure that only abstract products with a single concrete product have the add_to_cart_sku field in the Elasticsearch document.

4) Import data

Import warehouses and warehouse address data:

  1. Prepare your data according to your requirements using our demo data:

vendor/spryker/spryker/Bundles/StockDataImport/data/import/warehouse.csv

>name,is_active
Warehouse1,1
Warehouse2,1
Warehouse3,0
Roan Warehouse 1,1
Steenbok Warehouse 1,1
Spryker MER000001 Warehouse 1,1
Video King MER000002 Warehouse 1,1
Budget Cameras MER000005 Warehouse 1,1
Sony Experts MER000006 Warehouse 1,1
Column REQUIRED Data Type Data Example Data Explanation
name mandatory string Warehouse1 Name of the warehouse.
is_active mandatory bool 1 Defines if the warehouse is active.

vendor/spryker/spryker/Bundles/StockDataImport/data/import/warehouse_store.csv

>warehouse_name,store_name
Warehouse1,DE
Warehouse2,DE
Warehouse2,AT
Warehouse2,US
COLUMN REQUIRED DATA TYPE DATA EXAMPLE DATA EXPLANATION
warehouse_name mandatory string Warehouse1 Name of the warehouse.
store_name mandatory string DE Name of the store the warehouse will be available in.

data/import/common/common/warehouse_address.csv

>warehouse_name,address1,address2,address3,zip_code,city,region_name,country_iso2_code,phone,comment
Warehouse1,Hallesches Ufer 71,,,73271,Holzmaden,,DE,+49 7023 87 33 18,
Warehouse2,Leobnerstrasse 19,,,3107,Greiling,,AT,+43 699 173 76 39,
Warehouse3,641 Pursglove Court,,,97758,Riley,,US,+1 937-280-4973,
Spryker MER000001 Warehouse 1,Lietzenburger Strasse 73,,,52391,Vettweiß,,DE,+49 2252 53 42 48,
Video King MER000002 Warehouse 1,Los-Angeles-Platz 12,,,22826,Norderstedt,,DE,+49 40 44 63 66,
Budget Cameras MER000005 Warehouse 1,Kurfuerstendamm 96,,,89077,Ulm Weststadt,,DE,+49 73 52 52 98,
Sony Experts MER000006 Warehouse 1,Wallstrasse 58,,,53507,Dernau,,DE,+49 2643 48 41 25,
COLUMN REQUIRED DATA TYPE DATA EXAMPLE DATA EXPLANATION
warehouse_name mandatory string Warehouse1 Warehouse name.
address1 mandatory string Hallesches Ufer 71 The first line of the warehouse address.
address2 optional string The second line of the warehouse address.
address3 optional string The third line of the warehouse address.
zip_code mandatory string 73271 Zipcode.
city mandatory string Holzmaden City.
region_name optional string Region name from the spy_region table.
country_iso2_code mandatory string DE The ISO code of the country.
phone optional string +49 7023 87 33 18 Landline or any other contact phone.
comment optional string Any related comment.
“Verification”

Make sure that:

  1. The .csv files have an empty line in the end.
  2. For each warehouse_name entry in warehouse_address.csv, there is a respective name entry in the warehouse.csv.
  1. Update the following import action files with the following action:
    • data/import/common/commerce_setup_import_config_{SPRYKER_STORE}.yml
    • data/import/local/full\_{SPRYKER\_STORE}.yml
    • data/import/production/full\_{SPRYKER\_STORE}.yml
  - data_entity: stock-address
    source: data/import/common/common/warehouse_address.csv

Replace {SPRYKER_STORE} in the file paths with the desired stores. For example, EU, US, or AT.

  1. Register the following plugins to enable data import:

Add these plugins to the end of the plugins list but before the ProductOfferStockDataImportPlugin.

PLUGIN SPECIFICATION PREREQUISITES NAMESPACE
StockDataImportPlugin Imports warehouse data into the database. None \Spryker\Zed\StockDataImport\Communication\Plugin
StockStoreDataImportPlugin Imports data about the relationship between warehouses and stores into the database. None \Spryker\Zed\StockDataImport\Communication\Plugin
StockAddressDataImportPlugin Imports warehouse addresses. None Spryker\Zed\StockAddressDataImport\Communication\Plugin\DataImport

src/Pyz/Zed/DataImport/DataImportDependencyProvider.php

<?php

namespace Pyz\Zed\DataImport;

use Spryker\Zed\DataImport\DataImportDependencyProvider as SprykerDataImportDependencyProvider;
use Spryker\Zed\StockDataImport\Communication\Plugin\StockDataImportPlugin;
use Spryker\Zed\StockDataImport\Communication\Plugin\StockStoreDataImportPlugin;
use Spryker\Zed\StockAddressDataImport\Communication\Plugin\DataImport\StockAddressDataImportPlugin;

class DataImportDependencyProvider extends SprykerDataImportDependencyProvider
{
    /**
     * @return array
     */
    protected function getDataImporterPlugins(): array
    {
        return [
            new StockDataImportPlugin(),
            new StockStoreDataImportPlugin(),
			new StockAddressDataImportPlugin(),
        ];
    }
}
  1. In Pyz\Zed\DataImport\Business\DataImportBusinessFactory::getImporter(), move the existing product stock importer after the call of the addDataImporterPlugins():

src/Pyz/Zed/DataImport/DataImportDependencyProvider.php

<?php

namespace Pyz\Zed\DataImport\Business;

use Spryker\Zed\DataImport\Business\DataImportBusinessFactory as SprykerDataImportBusinessFactory;

/**
 * @method \Pyz\Zed\DataImport\DataImportConfig getConfig()
 */
class DataImportBusinessFactory extends SprykerDataImportBusinessFactory
{
    /**
     * @return \Spryker\Zed\DataImport\Business\Model\DataImporterCollectionInterface
     */
    public function getImporter()
    {
        $dataImporterCollection = $this->createDataImporterCollection();
        $dataImporterCollection->addDataImporterPlugins($this->getDataImporterPlugins());
        $dataImporterCollection->addDataImporter($this->createProductStockImporter());

        return $dataImporterCollection;
    }

}
  1. Enable behaviors by registering the console commands:

src/Pyz/Zed/Console/ConsoleDependencyProvider.php

<?php

namespace Pyz\Zed\Console;

use Spryker\Zed\Kernel\Container;
use Spryker\Zed\Console\ConsoleDependencyProvider as SprykerConsoleDependencyProvider;
use Spryker\Zed\DataImport\Communication\Console\DataImportConsole;
use Spryker\Zed\StockDataImport\StockDataImportConfig;
use Spryker\Zed\StockAddressDataImport\StockAddressDataImportConfig;

class ConsoleDependencyProvider extends SprykerConsoleDependencyProvider
{
    /**
     * @param \Spryker\Zed\Kernel\Container $container
     *
     * @return \Symfony\Component\Console\Command\Command[]
     */
    protected function getConsoleCommands(Container $container)
    {
        $commands = [
			new DataImportConsole(DataImportConsole::DEFAULT_NAME . ':' . StockDataImportConfig::IMPORT_TYPE_STOCK),
            new DataImportConsole(DataImportConsole::DEFAULT_NAME . ':' . StockDataImportConfig::IMPORT_TYPE_STOCK_STORE),
 			new DataImportConsole(DataImportConsole::DEFAULT_NAME . ':' . StockAddressDataImportConfig::IMPORT_TYPE_STOCK_ADDRESS),
		];

		return $commands;
    }
}
  1. Import data:
console data:import stock
console data:import stock-store
console data:import stock-address
Verification

Make sure that warehouse and warehouse address data have been added to the spy_stock, spy_stock_store and spy_stock_address tables.

5) Set up behavior 

Set up behavior:

  1. Build a navigation cache:
vendor/bin/console navigation:build-cache
  1. Configure the stock GUI module with a store form plugin.
PLUGIN SPECIFICATION PREREQUISITES NAMESPACE
StoreRelationToggleFormTypePlugin Store relation checklist form based on the existing stores. Spryker\Zed\Store\Communication\Plugin\Form

src/Pyz/Zed/StockGui/StockGuiDependencyProvider.php

<?php

namespace Pyz\Zed\StockGui;

use Spryker\Zed\Kernel\Communication\Form\FormTypeInterface;
use Spryker\Zed\StockGui\StockGuiDependencyProvider as SprykerStockGuiDependencyProvider;
use Spryker\Zed\Store\Communication\Plugin\Form\StoreRelationToggleFormTypePlugin;

class StockGuiDependencyProvider extends SprykerStockGuiDependencyProvider
{
    /**
     * @return \Spryker\Zed\Kernel\Communication\Form\FormTypeInterface
     */
    protected function getStoreRelationFormTypePlugin(): FormTypeInterface
    {
        return new StoreRelationToggleFormTypePlugin();
    }
}
Verification

Make sure that the navigation for Stock GUI has been successfully generated. Check that, in the navigation menu of the Back office, the Administration menu with the Warehouses submenu is displayed.

Register the following plugins for warehouse address management:

PLUGIN SPECIFICATION PREREQUISITES NAMESPACE
StockAddressStockPostCreatePlugin Creates a warehouse address if it’s attached to a warehouse create request. Spryker\Zed\StockAddress\Communication\Plugin\Stock
StockAddressStockPostUpdatePlugin Creates a warehouse address if it’s attached to a warehouse update request.
Removes an existing warehouse address if it’s not attached to a warehouse update request.		 Spryker\Zed\StockAddress\Communication\Plugin\Stock
StockAddressStockCollectionExpanderPlugin Expands a warehouse collection with related addresses. Spryker\Zed\StockAddress\Communication\Plugin\Stock
Zed/Stock/StockDependencyProvider.php 
<?php

namespace Pyz\Zed\Stock;

use Spryker\Zed\StockAddress\Communication\Plugin\Stock\StockAddressStockCollectionExpanderPlugin;
use Spryker\Zed\StockAddress\Communication\Plugin\Stock\StockAddressStockPostCreatePlugin;
use Spryker\Zed\StockAddress\Communication\Plugin\Stock\StockAddressStockPostUpdatePlugin;

class StockDependencyProvider extends SprykerStockDependencyProvider
{
    /**
     * @return \Spryker\Zed\StockExtension\Dependency\Plugin\StockCollectionExpanderPluginInterface[]
     */
    protected function getStockCollectionExpanderPlugins(): array
    {
        return [
            new StockAddressStockCollectionExpanderPlugin(),
        ];
    }

    /**
     * @return \Spryker\Zed\StockExtension\Dependency\Plugin\StockPostCreatePluginInterface[]
     */
    protected function getStockPostCreatePlugins(): array
    {
        return [
            new StockAddressStockPostCreatePlugin(),
        ];
    }

    /**
     * @return \Spryker\Zed\StockExtension\Dependency\Plugin\StockPostUpdatePluginInterface[]
     */
    protected function getStockPostUpdatePlugins(): array
    {
        return [
            new StockAddressStockPostUpdatePlugin(),
        ];
    }
}
Verification

Make sure that the warehouse address management works:

  • In the Back Office, create a warehouse.

  • Import a warehouse address using a data import functionality.

  • Check if the imported warehouse address exists in the spy_stock_address database table.

FEATURE REQUIRED FOR THE CURRENT FEATURE INTEGRATION GUIDE
Inventory Management API Install the Inventory Management Glue API
Alternative Products Alternative Products + Inventory Management feature integration - ongoing