Merchants and Merchant Relations feature integration

Edit on GitHub
You are browsing a previous version of the document. The latest version is 202212.0.

The Merchants and Merchant Relations feature is shipped with following modules:

Module Description
Merchant Implements logic of Merchants (adding, editing, removal).
MerchantGui Provides table with merchants along with the Create and Edit merchants pages in the Administration Interface.
MerchantRelationship Implements logic of merchant relations.
MerchantRelationshipGui Provides a table with merchant relations along with the Create and Edit merchant relations pages in the Administration Interface.
MerchantDataImport Implements an importer for merchants.
MerchantRelationshipDataImport Implements an importer for merchant relations.

To install the Merchants and Merchant relations feature, follow the steps below:

  1. Install necessary modules using composer: Update existing and install the required modules:
composer update "spryker/*" "spryker-shop/*"
composer require spryker/company-business-unit-data-import:"^0.2.0" spryker/merchant:"^1.0.0" spryker/merchant-data-import:"^0.1.0" spryker/merchant-gui:"^1.0.0" spryker/merchant-relationship:"^1.0.0" spryker/merchant-relationship-data-import:"^0.1.0" spryker/merchant-relationship-gui:"^1.0.0" --update-with-dependencies
  1. Run the commands:
console transfer:generate
console propel:install
  1. Add plugins to Zed DataImportDependencyProvider:
Module Plugin Description Method in Dependency Provider
DataImport MerchantDataImportPlugin Imports merchants. getDataImporterPlugins
DataImport MerchantRelationshipDataImportPlugin Imports merchant relations. getDataImporterPlugins


use Spryker\Zed\MerchantDataImport\Communication\Plugin\MerchantDataImportPlugin;
use Spryker\Zed\MerchantRelationshipDataImport\Communication\Plugin\MerchantRelationshipDataImportPlugin;
protected function getDataImporterPlugins(): array
    return [
        new MerchantDataImportPlugin(),
        new MerchantRelationshipDataImportPlugin(),

Last reivew date: Jul 9, 2018