How To Import Product Data Programmatically In Magento 2

In Magento 2, How To, Magento 2 SolutionsApril 20, 2020

How To Import Product Data Programmatically In Magento 2

The post is all about getting the Magento 2 product data.

Import product data in the CSV format and then it can be used to implement any product-based feature. For example, the products with a price higher than a certain amount can be shipped with free delivery, or a product from a certain category includes a gift coupon, etc.

Import product data programmatically in Magento 2 store and use it to make your store feature-rich, to earn maximum profit, or to boost your marketing approach!

Steps to import product data programmatically in Magento 2:

<?php
	
	$file = fopen('var/import/new.csv', 'r', '"'); // set path to the CSV file
if ($file !== false) {

    require __DIR__ . '/app/bootstrap.php';
    $bootstrap = \Magento\Framework\App\Bootstrap::create(BP, $_SERVER);

    $objectManager = $bootstrap->getObjectManager();

    $state = $objectManager->get('Magento\Framework\App\State');
    $state->setAreaCode('adminhtml');

    // used for updating product stock - and it's important that it's inside the while loop
    $stockRegistry = $objectManager->get('Magento\CatalogInventory\Api\StockRegistryInterface');

    // add logging capability
    $writer = new \Zend\Log\Writer\Stream(BP . '/var/log/import-new.log');
    $logger = new \Zend\Log\Logger();
    $logger->addWriter($writer);

    $header = fgetcsv($file); // get data headers and skip 1st row

    // enter the min number of data fields you require that the new product will have (only if you want to standardize the import)
    $required_data_fields = 3;

    while ( $row = fgetcsv($file, 3000, ",") ) {

        $data_count = count($row);
        if ($data_count < 1) {
            continue;
        }

        // used for setting the new product data
        $product = $objectManager->create('Magento\Catalog\Model\Product');         
        $data = array();
        $data = array_combine($header, $row);

        $sku = $data['sku'];
        if ($data_count < $required_data_fields) {
            $logger->info("Skipping product sku " . $sku . ", not all required fields are present to create the product.");
            continue;
        }

        $name = $data['name'];
        $description = $data['description'];
        $shortDescription = $data['short_description'];
        $qty = trim($data['qty']);
        $price = trim($data['price']);

        try {
            $product->setTypeId('simple') // type of product you're importing
                    ->setStatus(1) // 1 = enabled
                    ->setAttributeSetId(4) // In Magento 2.2 attribute set id 4 is the Default attribute set (this may vary in other versions)
                    ->setName($name)
                    ->setSku($sku)
                    ->setPrice($price)
                    ->setTaxClassId(0) // 0 = None
                    ->setCategoryIds(array(2, 3)) // array of category IDs, 2 = Default Category
                    ->setDescription($description)
                    ->setShortDescription($shortDescription)
                    ->setUrlKey($url_key) // you don't need to set it, because Magento does this by default, but you can if you need to
                    ->setWebsiteIds(array(1)) // Default Website ID
                    ->setStoreId(0) // Default store ID
                    ->setVisibility(4) // 4 = Catalog & Search
                    ->save();

        } catch (\Exception $e) {
            $logger->info('Error importing product sku: '.$sku.'. '.$e->getMessage());
            continue;
        }

        try {
            $stockItem = $stockRegistry->getStockItemBySku($sku);

            if ($stockItem->getQty() != $qty) {
                $stockItem->setQty($qty);
                if ($qty > 0) {
                    $stockItem->setIsInStock(1);
                }
                $stockRegistry->updateStockItemBySku($sku, $stockItem);
            }
        } catch (\Exception $e) {
            $logger->info('Error importing stock for product sku: '.$sku.'. '.$e->getMessage());
            continue;
        }
        unset($product);
    }
    fclose($file);
}
	
?>

<?php

$file = fopen('var/import/new.csv', 'r', '"'); // set path to the CSV file

if ($file !== false) {

require __DIR__ . '/app/bootstrap.php';

$bootstrap = \Magento\Framework\App\Bootstrap::create(BP, $_SERVER);

$objectManager = $bootstrap->getObjectManager();

$state = $objectManager->get('Magento\Framework\App\State');

$state->setAreaCode('adminhtml');

// used for updating product stock - and it's important that it's inside the while loop

$stockRegistry = $objectManager->get('Magento\CatalogInventory\Api\StockRegistryInterface');

// add logging capability

$writer = new \Zend\Log\Writer\Stream(BP . '/var/log/import-new.log');

$logger = new \Zend\Log\Logger();

$logger->addWriter($writer);

$header = fgetcsv($file); // get data headers and skip 1st row

// enter the min number of data fields you require that the new product will have (only if you want to standardize the import)

$required_data_fields = 3;

while ( $row = fgetcsv($file, 3000, ",") ) {

$data_count = count($row);

if ($data_count < 1) {

continue;

}

// used for setting the new product data

$product = $objectManager->create('Magento\Catalog\Model\Product');

$data = array();

$data = array_combine($header, $row);

$sku = $data['sku'];

if ($data_count < $required_data_fields) {

$logger->info("Skipping product sku " . $sku . ", not all required fields are present to create the product.");

continue;

}

$name = $data['name'];

$description = $data['description'];

$shortDescription = $data['short_description'];

$qty = trim($data['qty']);

$price = trim($data['price']);

try {

$product->setTypeId('simple') // type of product you're importing

->setStatus(1) // 1 = enabled

->setAttributeSetId(4) // In Magento 2.2 attribute set id 4 is the Default attribute set (this may vary in other versions)

->setName($name)

->setSku($sku)

->setPrice($price)

->setTaxClassId(0) // 0 = None

->setCategoryIds(array(2, 3)) // array of category IDs, 2 = Default Category

->setDescription($description)

->setShortDescription($shortDescription)

->setUrlKey($url_key) // you don't need to set it, because Magento does this by default, but you can if you need to

->setWebsiteIds(array(1)) // Default Website ID

->setStoreId(0) // Default store ID

->setVisibility(4) // 4 = Catalog & Search

->save();

} catch (\Exception $e) {

$logger->info('Error importing product sku: '.$sku.'. '.$e->getMessage());

continue;

}

try {

$stockItem = $stockRegistry->getStockItemBySku($sku);

if ($stockItem->getQty() != $qty) {

$stockItem->setQty($qty);

if ($qty > 0) {

$stockItem->setIsInStock(1);

}

$stockRegistry->updateStockItemBySku($sku, $stockItem);

}

} catch (\Exception $e) {

$logger->info('Error importing stock for product sku: '.$sku.'. '.$e->getMessage());

continue;

}

unset($product);

}

fclose($file);

}

Example CSV for importing new products:

"sku","name","description","short_description","price","qty"
"test-sku1","Test product name1","Test product description1","Test product short description1","100","20"
"test-sku2","Test product name2","Test product description2","Test product short description2","10","30"

"sku","name","description","short_description","price","qty"

"test-sku1","Test product name1","Test product description1","Test product short description1","100","20"

"test-sku2","Test product name2","Test product description2","Test product short description2","10","30"

That’s it.

You can use the above example with necessary changes as per your business requirements.

Any doubts in the implementation can be mentioned in the Comments section below. I’d be happy to help you out.

Do share the solution with Magento community via social media.

Thank you.

4.6

(based on 14 Reviews)

Sanjay Jethva

Sanjay is a co-founder at Meetanshi. He is a Certified Magento Developer who loves creating Magento E-commerce solutions. Owing to his contributions in Magento Forums and posting solutions, he is among the top 50 contributors of the Magento community in 2019. When he is not engrossed with anything related to Magento, he loves to play cricket.

14 comments On How To Import Product Data Programmatically In Magento 2

Adriano
February 25, 2021 at 4:43 pm - Reply
Hello again Sanjay and thankyou again.
I just implemented it with ease in 2.2.11
I also followed your post to add programmatically images, well done!
Now you should complete the series 🙂
How to upload images for a product.
Have a nice day
- Sanjay Jethva
  March 1, 2021 at 10:47 am - Reply
  Hello,
  Please refer to https://meetanshi.com/blog/add-images-to-product-gallery-in-magento-2/
  You can change url ($url = $importDir . $product->getImage(); ) as per your image path directory.
  I hope it helps.
Adriano
February 23, 2021 at 7:28 pm - Reply
Thank you for script, I’m just looking at it now.
Before try it I have just a couple of questions
I’m working on version 2.2.11 is it compatible ?
Related field as category id and taxes must already exists ?
Or can I update them later ?
Do you have any indication to import that items.
Can also run it programmatically ?
Thanks for your help
- Sanjay Jethva
  February 24, 2021 at 6:10 pm - Reply
  Hello,
  Yes, it will work in version 2.2.11
  You can create the product and for tax, pass the ID in setTaxClassId()
  It won’t be assigned to category. You’ll have to do it manually or customize the code. You can refer to https://meetanshi.com/blog/programmatically-assign-products-to-multiple-categories-in-magento-2/
  You can run it programmatically and also update the product afterwards.
  Thank you.
MohammadSadegh Maleki
September 10, 2020 at 6:07 pm - Reply
Thank you, Sanjay for your article. actually I was looking for a solution for my self and found your article on google. it’s great.
- Sanjay Jethva
  September 11, 2020 at 9:41 am - Reply
  Thanks!
Jai
September 2, 2020 at 11:47 pm - Reply
Hi Sanjay,
I want to fetch product data and export them . can you please help me out.? that would be helpful for me.
- Sanjay Jethva
  September 3, 2020 at 12:35 pm - Reply
  Hello,
  The above post is to import data from CSV. The solution that you want needs customization.
  Thanks.
Pritesh
August 19, 2020 at 5:26 pm - Reply
How to use this code in custom module. Will you please help me with this @Sanjay or if i want to use for by backend means admin side.
- Sanjay Jethva
  August 20, 2020 at 12:37 pm - Reply
  Hello Pritesh,
  I have posted the solution using the root script. If you want to do it using a block or controller, you can simply create an object.
  Thank you.
Susheel
June 20, 2020 at 5:08 pm - Reply
Great tutorial Sanjay bhai!
What about saving images upload during bulk import can you also explain that?
- Sanjay Jethva
  June 22, 2020 at 11:18 am - Reply
  Hello Susheel,
  Thanks for the appreciation.
  To save images upload during bulk import, check this:
  Add ‘image’ in CSV and pass value of imageName .
  For example: demo.csv
  "sku","name","description","short_description","price","qty","image" "test-sku1","Test product name1","Test product description1","Test product short description1","100","20","img_1.jpg" $img = DomainUrl . '/pub/media/catalog/product'; //This is the directory path from where you have to take the images$url = $img . $data['image'];$product->addImageToMediaGallery($url, array('image', 'small_image', 'thumbnail'), true, false);
  You can refer the solution at How To Programmatically Add Images to Product Gallery in Magento 2
  Thank you.
  - Susheel
    July 7, 2020 at 4:17 pm - Reply
    Thank you so much Sanjay Bhai!
    You are one of the best mentor!
    
    Sanjay Jethva
    July 7, 2020 at 4:25 pm - Reply
    Thank you very much for such appreciative words. It means a lot!

How To Import Product Data Programmatically In Magento 2

Steps to import product data programmatically in Magento 2:

Sanjay Jethva

14 comments On How To Import Product Data Programmatically In Magento 2

Leave a reply: Cancel Reply

Customer Service

Quick Links

Client's Love

How To Import Product Data Programmatically In Magento 2

Steps to import product data programmatically in Magento 2:

Get Weekly Updates

Sanjay Jethva

14 comments On How To Import Product Data Programmatically In Magento 2

Leave a reply: Cancel Reply

<img alt="Meetanshi" class="footer-logo-img" src="https://meetanshi.com/blog/wp-content/uploads/2020/01/meetanshi_small.png"/>

Customer Service

Quick Links

Client's Love