Cloud HostingLaunch UnoPim on fully-managed cloud hosting — fast, secure and cost-effective plans.
Skip to content

Installation

The UnoPim Magento 2 Connector links UnoPim with Magento 2 and helps streamline product synchronization between both platforms.

This installation process includes two parts:

  • Installing the required Magento 2 plugin.
  • Installing and registering the UnoPim Magento 2 Connector inside your UnoPim project.

Required Magento 2 Plugin

Before using the connector, you need to install the required Magento 2 plugin:

  • Plugin Name: ProductImportQueue

Install the Magento 2 Plugin

Step 1: Extract and Move the Plugin Files

Extract the Magento2Plugin package.

Then move the app folder from inside the src directory into the root directory of your Magento installation.

Step 2: Enable the Magento Module

Run the following commands in your Magento root directory:

bash
php bin/magento module:enable Webkul_ProductImportQueue
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
CommandPurpose
php bin/magento module:enable Webkul_ProductImportQueueEnables the required Magento module.
php bin/magento setup:upgradeApplies module database/schema updates.
php bin/magento setup:di:compileRebuilds Magento dependency injection classes.
php bin/magento setup:static-content:deployPublishes static frontend/admin assets.

Step 3: Flush Cache and Reindex

After enabling the module, run the following commands:

bash
php bin/magento cache:clean
php bin/magento indexer:reindex
CommandPurpose
php bin/magento cache:cleanClears Magento cache entries after module setup.
php bin/magento indexer:reindexRebuilds Magento indexes for updated data visibility.

Install the UnoPim Magento 2 Connector

Unzip the connector package and merge the packages folder into the root directory of your UnoPim project.

Register the Package Provider

Open the bootstrap/providers.php file and add the following import:

php
use Webkul\Magento2\Providers\Magento2ServiceProvider;

Then, inside the returned providers array, add:

php
Magento2ServiceProvider::class,

NOTE

This registers Magento2ServiceProvider in Laravel so the connector can bootstrap its services, routes, and package configuration during application startup.

Update Composer Autoload

Open the composer.json file and add the following line under the psr-4 section:

json
"Webkul\\Magento2\\": "packages/Webkul/Magento2/src"

Run the Installation Commands

Run the following commands from your UnoPim project root:

Dump Composer Autoload

bash
composer dump-autoload

Install the Magento 2 Package

bash
php artisan magento-package:install

Clear the Application Cache

bash
php artisan optimize:clear
CommandPurpose
composer dump-autoloadRegenerates Composer's autoloader mapping to include the newly added namespace.
php artisan magento-package:installRuns the connector installer to apply required setup tasks.
php artisan optimize:clearClears all cached files (bootstrap, configuration, routes, and views) to load the new changes.

Released under the MIT License.