How to Import Related Products to Magento 2?

April 25, 2018 - Fire development, Magento 2

Magento 2 Development; Magento 2 tutorial

The following article is based on a StackExchange question by Guest. The author asks how to import related products to Magento 2. Although the desired functionality was added to the new platform version, you may still face certain issues moving this data type to your store.

Even if a CSV file has a row with the related_skus attribute with the specified data for a product, the default import process may not be flawless. If in admin under Products->Catalog the imported product contains no related products in the Related Products sidebar tab but those products exist in the catalog with SKUs, you’ve come to the right place.

Raul Sanchez provides the possible solution to the problem. He assumes that the default import module has some kind of bug with related products. Raul’s solution is based on a new console command.

The command expects a 2-columns related.csv file in the var folder. The columns are parent SKU & children SKUs. A comma is a CSV separator, and a pipe is a children_skus separator.

Below, you can see the corresponding files. Replace Sinapsis with your vendor name, and Sync with the module name. After installing the module, run bin/magento setup:upgrade & you’ll see the new command under bin/magento list. Execute it by running

bin/magento sync:related

1	bin/magento sync:related

Also, note that since the 2.2 version, there are 2 changes required: an extra line before saving $product. This, you will prevent this issue.

$product->unsetData('media_gallery');

1	$product->unsetData('media_gallery');

Besides, it is necessary to change admin to adminhtml in

$this->_appState->setAreaCode('adminhtml');

1	$this->_appState->setAreaCode('adminhtml');

Note that the first change is innocuous for older Magento 2 versions. The second one may be harmful. Therefore, the following code contains only the first change:

app / code / Sinapsis / Sync / etc / di.xml

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
<type name="Magento\Framework\Console\CommandList">
    <arguments>
        <argument name="commands" xsi:type="array">
            <item name="sync_related" xsi:type="object">Sinapsis\Sync\Console\Command\RelatedCommand</item>
        </argument>
    </arguments>
</type>

<?xml version="1.0"?>

<item name="sync_related" xsi:type="object">Sinapsis\Sync\Console\Command\RelatedCommand</item>

</argument>

</arguments>

</type>

app / code / Sinapsis / Sync / etc / module.xml

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="module.xsd">
<module name="Sinapsis_Sync" setup_version="1.0.0">
</module>

<?xml version="1.0"?>

</module>

app / code / Sinapsis / Sync / registration.php

<?php
\Magento\Framework\Component\ComponentRegistrar::register(
    \Magento\Framework\Component\ComponentRegistrar::MODULE,
    'Sinapsis_Sync',
    __DIR__
);

<?php

\Magento\Framework\Component\ComponentRegistrar::register(

\Magento\Framework\Component\ComponentRegistrar::MODULE,

'Sinapsis_Sync',

__DIR__

);

app / code / Sinapsis / Sync / Console / Command / RelatedCommand.php

<?php
namespace Sinapsis\Sync\Console\Command;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Magento\Framework\ObjectManagerInterface;
use Magento\Framework\App\State as AppState;
use Magento\Framework\App\Filesystem\DirectoryList;

class RelatedCommand extends Command
{
    const CSV_SEPARATOR = ',';
    const CHILDREN_SEPARATOR = '|';

    protected $_appState;
    protected $_objectManager;
    protected $_directorylist;

    public function __construct(
        DirectoryList $_directorylist,
        AppState $appState,
        ObjectManagerInterface $objectManager
    ) {
        $this->_appState = $appState;
        $this->_objectManager = $objectManager;
        $this->_directorylist = $_directorylist;
        parent::__construct();
    }

    protected function configure()
    {
        $this->setName('sync:related')
            ->setDescription('Synchronize catalog related products');
        parent::configure();
    }

    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $output->writeln('<info>Starting process...<info>');
        $output->writeln('');

        $this->_appState->setAreaCode('admin');
        $productRepository = $this->_objectManager->create('Magento\Catalog\Model\ProductRepository');
        $output->writeln('<info>Loading csv content...<info>');
        $output->writeln('');

        $filePath = $this->_directorylist->getPath('var') . DIRECTORY_SEPARATOR . 'related.csv';
        //@todo control Exception if file does not exist
        $parseData = array();
        if (($handle = fopen($filePath, "r")) !== FALSE) {
            while (($data = fgetcsv($handle, 0, self::CSV_SEPARATOR)) !== FALSE) {
                $parseData[] = $data;
            }
            fclose($handle);
        } else {
            $output->writeln('<info>Could not read .csv file<info>');
            return;
        }
        $headers = array_shift($parseData); // remove headers

        foreach ($parseData as $row){

            $skuParent = trim($row[0]);
            $skuChildren = trim($row[1]);
            $output->writeln('<info>Loading parent product ' . $skuParent . ' ... <info>');

            try {
                $product = $productRepository->get($skuParent);
            } catch (\Magento\Framework\Exception\NoSuchEntityException $e){
                $output->writeln('<info>Could not load!<info>');
                continue;
            }

            $links = $product->getProductLinks();
            $children = explode(self::CHILDREN_SEPARATOR, $skuChildren);

            $i = 1;
            foreach ($children as $skuChild){

                $output->writeln('<info>Loading related product ' . $skuChild . ' ... <info>');

                try {
                    $child = $productRepository->get($skuChild);
                } catch (\Magento\Framework\Exception\NoSuchEntityException $e){
                    $output->writeln('<info>Could not load!<info>');
                    continue;
                }

                $productLink = $this->_objectManager->create('Magento\Catalog\Api\Data\ProductLinkInterface')
                    ->setSku($skuParent)
                    ->setLinkedProductSku($skuChild)
                    ->setPosition($i)
                    ->setLinkType('related');
                $links[] = $productLink;
                $i++;
            }

            $product->setProductLinks($links);
            $product->unsetData('media_gallery');
            $productRepository->save($product);
            $output->writeln('<info>Relations saved for ' . $skuParent . '<info>');

        }
        $output->writeln('');
        $output->writeln('<info>Done<info>');
    }
}

100

101

102

103

104

105

106

107

<?php

namespace Sinapsis\Sync\Console\Command;

use Symfony\Component\Console\Command\Command;

use Symfony\Component\Console\Input\InputInterface;

use Symfony\Component\Console\Output\OutputInterface;

use Magento\Framework\ObjectManagerInterface;

use Magento\Framework\App\State as AppState;

use Magento\Framework\App\Filesystem\DirectoryList;

class RelatedCommand extends Command

{

const CSV_SEPARATOR = ',';

const CHILDREN_SEPARATOR = '|';

protected $_appState;

protected $_objectManager;

protected $_directorylist;

public function __construct(

DirectoryList $_directorylist,

AppState $appState,

ObjectManagerInterface $objectManager

) {

$this->_appState = $appState;

$this->_objectManager = $objectManager;

$this->_directorylist = $_directorylist;

parent::__construct();

}

protected function configure()

{

$this->setName('sync:related')

->setDescription('Synchronize catalog related products');

parent::configure();

}

protected function execute(InputInterface $input, OutputInterface $output)

{

$output->writeln('<info>Starting process...<info>');

$output->writeln('');

$this->_appState->setAreaCode('admin');

$productRepository = $this->_objectManager->create('Magento\Catalog\Model\ProductRepository');

$output->writeln('<info>Loading csv content...<info>');

$output->writeln('');

$filePath = $this->_directorylist->getPath('var') . DIRECTORY_SEPARATOR . 'related.csv';

//@todo control Exception if file does not exist

$parseData = array();

if (($handle = fopen($filePath, "r")) !== FALSE) {

while (($data = fgetcsv($handle, 0, self::CSV_SEPARATOR)) !== FALSE) {

$parseData[] = $data;

}

fclose($handle);

} else {

$output->writeln('<info>Could not read .csv file<info>');

return;

}

$headers = array_shift($parseData); // remove headers

foreach ($parseData as $row){

$skuParent = trim($row[0]);

$skuChildren = trim($row[1]);

$output->writeln('<info>Loading parent product ' . $skuParent . ' ... <info>');

try {

$product = $productRepository->get($skuParent);

} catch (\Magento\Framework\Exception\NoSuchEntityException $e){

$output->writeln('<info>Could not load!<info>');

continue;

}

$links = $product->getProductLinks();

$children = explode(self::CHILDREN_SEPARATOR, $skuChildren);

$i = 1;

foreach ($children as $skuChild){

$output->writeln('<info>Loading related product ' . $skuChild . ' ... <info>');

try {

$child = $productRepository->get($skuChild);

} catch (\Magento\Framework\Exception\NoSuchEntityException $e){

$output->writeln('<info>Could not load!<info>');

continue;

}

$productLink = $this->_objectManager->create('Magento\Catalog\Api\Data\ProductLinkInterface')

->setSku($skuParent)

->setLinkedProductSku($skuChild)

->setPosition($i)

->setLinkType('related');

$links[] = $productLink;

$i++;

}

$product->setProductLinks($links);

$product->unsetData('media_gallery');

$productRepository->save($product);

$output->writeln('<info>Relations saved for ' . $skuParent . '<info>');

}

$output->writeln('');

$output->writeln('<info>Done<info>');

}

It is a quite complex solution, isn’t it? You can essentially simplify the way you import related products to Magento 2 with our Improved Import & Export Magento 2 extension. The module extends the default functionality of the platform and adds lots of new features to product import. Since related products are supported by default, our extension also allows moving them to Magento 2.

Besides, it enhances product import with the ability to create a schedule for fully automated updates; the mapping functionality to match all third-party attributes to default attributes of Magento 2; hardcoded values for selected attributes, etc. For further information, follow the link below:

Download/Buy Improved Import & Export Magento 2 Extension

We hope the article was useful. For other useful Magento 2 tips, check out our Cookbook.

Post Tags:import magento 2 Magento 2 Developer’s Cookbook related products

← Previous Post Next Post →

Magento 2 MSI User Guide: How to Import & Export Magento 2 MSI (Multi Source Inventory)

This Magento 2 MSI user guide briefly explains the platform's multi-source inventory functionality and then focuses on the Magento 2… Read more…
How to Import Data via REST API into Magento 2

Today, we'd like to draw your attention to the Magento 2 REST API Import. Depending on the edition of your… Read more…
The Ultimate Guide to Shopify Import

Every decent e-commerce platform offers built-in import and export tools. However, they are usually far from being an omnipotent solution… Read more…
How to Import Database in Magento 2

Recently, we’ve spotted a question on StackExchange regarding the Magento 2 database import. David Duong faced problems while transferring a… Read more…
Guide to Magento 2 Search Terms & Search Synonyms: Management, Import & Export Recomendations

Today, we are going to explore two tightly connected topics - Magento 2 search terms and Magento 2 search synonyms.… Read more…
Improved Import, Export & Mass Actions app for Shopware 6 user manual

Improved Import, Export & Mass Actions is the Shopware 6 app that is installed on your store, and allows you… Read more…
Magento 2 Tax Configuration: How to Add Tax Classes, Rules & Rates, Tax Rates Import & Export

Today, we'd like to draw your attention to the Magento 2 tax configuration. You will learn what the Magento 2 estimate shipping… Read more…
FPT Tax: How to Add and Import Fixed Product Tax in Magento 2

Today, we are going to talk about the FPT tax. You will learn what FPT or Fixed Product Tax is… Read more…
Guide to Magento 2 Static Blocks

Below, we are going to discuss Magento 2 static blocks. It is hard to overestimate the importance of Magento 2… Read more…
How to Import & Export Product Attributes for Magento 2

Do you know how to import attributes in Magento 2? It's a complex process that covers not only product attributes but also attribute… Read more…
Magento 2 Categories Import & Export Guide

Today, we are going to talk about Magento 2 categories import and export. Unfortunately, the platform doesn't let you import… Read more…
Magento 2 Advanced Pricing Import: Special Prices, Group Prices, Tier Prices & MAP

Today, we are going to talk about the Magento 2 advanced pricing import. In this guide, we explain for types… Read more…
The Complete Guide to Magento 2 Custom Options (Customizable Options)

The following guide describes custom options in Magento 2. You will learn what Magento 2 custom options are and how… Read more…
FireBear Improved Import & Export for Magento 2 – Extension Change Log

The following blog post will help you retrace the evolution of the Improved Import & Export Magento 2 module. The… Read more…
Improved Import / Export Magento 2 Extension Manual

In this article, we'd like to draw your attention to the Improved Import & Export Magento 2 extensions. The following… Read more…
How to use external image URLs in Magento 2 import

The following article explains how to use external image URLs in Magento 2 import. Although this functionality is possible by… Read more…
How to fix “The source file moving process failed” error in Magento 2

In this article, we explain how to fix the "The source file moving process failed" error in Magento 2. It… Read more…
How to import product images in Magento 2 when they already exist in pub/media

Have you ever been in a situation when Magento 2 doesn’t let you import product images? Although there may be… Read more…
How To Add ‘Delete Confirmation Popup’ In Magento 2 For Default Import Functionality

Kavya cheerala asks for help in the following situation via a Stack Exchange question. The author has added a custom… Read more…
Matrixify Shopify App In-Depth Review: Is It That Powerful?

What is Matrixify? How to use Matrixify? What are its core features and goals? Below, we review the Matrixify Shopify… Read more…

Related posts