How to export data from Magento 2 in XLS & XLSX formats

January 14, 2021 - E-Commerce, Magento 2

Magento 2 export CLI

Recently, we’ve come across a question by user00247 regarding how to export data from Magento 2 in an XLS format. Another StackExchange user proposed a solution that is also provided below. However, it is aimed at technical users only. Therefore, we’ve decided to elaborate the provided answer with an alternative solution, shedding light on how to export data from Magento 2 in XLS & XLSX formats and what’s the difference between them. Before going any further, pay heed to the fact that Magento 2 supports neither XLS nor XLSX files by default.

Bear in mind that we can help you with any import and export tasks that take place in Magento 2. Contact us for further information.

Understanding xls and xlsx

XLS is a standard file extension for a spreadsheet file format created for storing Microsoft Excel documents, known as the Binary Interchange File Format (BIFF). In its turn, XLSX is another kind of Microsoft Excel spreadsheets that features calculation, graphing tools, pivot tables, and macro programming. As you might know, the latter is the latest version of Microsoft Excel while the former is the older one. Thus, XLS is associated with the 2003 version of Excel, while XLSX is related to versions since 2007.

It is also necessary to mention that XLSX and XLS files store information differently. As we’ve just mentioned, XLS is based on BIFF, keeping all the data ordered in a binary format. As for XLSX, it incorporates the Office Open XML format, storing all the data in a text file that utilizes XML for defining parameters.

Also, the performance of the two file types differs. XLS files are faster than XLSX when you use complex formulas and large sets of data.

It is also worth mentioning that XLS files are supported in all Excel versions while XLSX sheets can be processed in Microsoft Excel versions 2007 and onwards.

From the perspective of Magento 2 data export, XLS and XLSX are quite similar and interchangeable. If you want to process data files in Excel 2007+ you can freely use XLSX instead of XLS. If your editor is older, you either need to run the XLS export or convert XLSX into XLS. So, how to export data from Magento 2 via XLS?

How to export XLS files from Magento 2

Nilesh Gosai proposes the following solution to export data from Magento 2 via XLS files:

Firstly, he recommends adding the following code in (“app/code/NameSpace/Module/view/adminhtml/ui_component/”) listing the XML file between <listingToolbar> and </listingToolbar> tags:

<exportButton class="Magento\Ui\Component\ExportButton">
            <argument name="data" xsi:type="array">
                <item name="config" xsi:type="array">
                    <item name="options" xsi:type="array">
                        <item name="cvs" xsi:type="array">
                            <item name="value" xsi:type="string">csv</item>
                            <item name="label" xsi:type="string" translate="true">CSV</item>
                            <item name="url" xsi:type="string">mui/export/gridToCsv</item>
                        </item>
                        <item name="xml" xsi:type="array">
                            <item name="value" xsi:type="string">xml</item>
                            <item name="label" xsi:type="string" translate="true">Excel XML</item>
                            <item name="url" xsi:type="string">mui/export/gridToXml</item>
                        </item>
                        <item name="xls" xsi:type="array">
                            <item name="value" xsi:type="string">xls</item>
                            <item name="label" xsi:type="string" translate="true">Excel XLS</item>
                            <item name="url" xsi:type="string">{{module}}/export/gridToXls</item>
                        </item>
                    </item>
                </item>
            </argument>
        </exportButton>

<item name="url" xsi:type="string">mui/export/gridToCsv</item>

</item>

<item name="label" xsi:type="string" translate="true">Excel XML</item>

<item name="url" xsi:type="string">mui/export/gridToXml</item>

</item>

<item name="label" xsi:type="string" translate="true">Excel XLS</item>

<item name="url" xsi:type="string">{{module}}/export/gridToXls</item>

</item>

</argument>

</exportButton>

Secondly, it is necessary to create the “GridToXls.php” file in app/code/Namespace/Module/Controller/Adminhtml/Export. Add the following code to the file:

<?php
/**
 * Copyright © 2013-2017 Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
namespace Namespace\Module\Controller\Adminhtml\Export;

use Magento\Backend\App\Action;
use Magento\Backend\App\Action\Context;
use Namespace\Module\Model\Export\ConvertToXls;
use Magento\Framework\App\Response\Http\FileFactory;

/**
 * Class Render
 */
class GridToXls extends Action
{
    /**
     * @var ConvertToXls
     */
    protected $converter;

    /**
     * @var FileFactory
     */
    protected $fileFactory;

    /**
     * @param Context $context
     * @param ConvertToXml $converter
     * @param FileFactory $fileFactory
     */
    public function __construct(
        Context $context,
        ConvertToXls $converter,
        FileFactory $fileFactory
    ) {
        parent::__construct($context);
        $this->converter = $converter;
        $this->fileFactory = $fileFactory;
    }

    /**
     * Export data provider to XML
     *
     * @throws \Magento\Framework\Exception\LocalizedException
     * @return \Magento\Framework\App\ResponseInterface
     */
    public function execute()
    {
        return $this->fileFactory->create('export.xls', $this->converter->getXlsFile(), 'var');
    }
}

<?php

/**

* See COPYING.txt for license details.

namespace Namespace\Module\Controller\Adminhtml\Export;

use Magento\Backend\App\Action;

use Magento\Backend\App\Action\Context;

use Namespace\Module\Model\Export\ConvertToXls;

use Magento\Framework\App\Response\Http\FileFactory;

/**

* Class Render

class GridToXls extends Action

{

/**

* @var ConvertToXls

protected $converter;

/**

* @var FileFactory

protected $fileFactory;

/**

* @param Context $context

* @param ConvertToXml $converter

* @param FileFactory $fileFactory

public function __construct(

Context $context,

ConvertToXls $converter,

FileFactory $fileFactory

) {

parent::__construct($context);

$this->converter = $converter;

$this->fileFactory = $fileFactory;

}

/**

* Export data provider to XML

* @throws \Magento\Framework\Exception\LocalizedException

* @return \Magento\Framework\App\ResponseInterface

public function execute()

{

return $this->fileFactory->create('export.xls', $this->converter->getXlsFile(), 'var');

}

Thirdly, the “ConvertToXls.php” file is required. Create it in app/code/Namespace/Module/Model/Export with the following code inside:

<?php
/**
 * Copyright © 2013-2017 Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
namespace Namespace\Module\Model\Export;

use Magento\Ui\Model\Export\MetadataProvider;
use Magento\Ui\Model\Export\SearchResultIteratorFactory;
use Magento\Framework\Api\Search\DocumentInterface;
use Magento\Framework\Api\Search\SearchResultInterface;
use Magento\Framework\App\Filesystem\DirectoryList;
use Magento\Framework\Convert\Excel;
use Magento\Framework\Convert\ExcelFactory;
use Magento\Framework\Exception\LocalizedException;
use Magento\Framework\Filesystem;
use Magento\Framework\Filesystem\Directory\WriteInterface;
use Magento\Ui\Component\MassAction\Filter;

/**
 * Class ConvertToXls
 */
class ConvertToXls
{
    /**
     * @var WriteInterface
     */
    protected $directory;

    /**
     * @var MetadataProvider
     */
    protected $metadataProvider;

    /**
     * @var ExcelFactory
     */
    protected $excelFactory;

    /**
     * @var array
     */
    protected $options;

    /**
     * @var SearchResultIteratorFactory
     */
    protected $iteratorFactory;

    /**
     * @var array
     */
    protected $fields;

    /**
     * @param Filesystem $filesystem
     * @param Filter $filter
     * @param MetadataProvider $metadataProvider
     * @param ExcelFactory $excelFactory
     * @param SearchResultIteratorFactory $iteratorFactory
     */
    public function __construct(
        Filesystem $filesystem,
        Filter $filter,
        MetadataProvider $metadataProvider,
        ExcelFactory $excelFactory,
        SearchResultIteratorFactory $iteratorFactory
    ) {
        $this->filter = $filter;
        $this->directory = $filesystem->getDirectoryWrite(DirectoryList::VAR_DIR);
        $this->metadataProvider = $metadataProvider;
        $this->excelFactory = $excelFactory;
        $this->iteratorFactory = $iteratorFactory;
    }

    /**
     * Returns Filters with options
     *
     * @return array
     */
    protected function getOptions()
    {
        if (!$this->options) {
            $this->options = $this->metadataProvider->getOptions();
        }
        return $this->options;
    }

    /**
     * Returns DB fields list
     *
     * @return array
     */
    protected function getFields()
    {
        if (!$this->fields) {
            $component = $this->filter->getComponent();
            $this->fields = $this->metadataProvider->getFields($component);
        }
        return $this->fields;
    }

    /**
     * Returns row data
     *
     * @param DocumentInterface $document
     * @return array
     */
    public function getRowData(DocumentInterface $document)
    {
        return $this->metadataProvider->getRowData($document, $this->getFields(), $this->getOptions());
    }

    /**
     * Returns XML file
     *
     * @return array
     * @throws LocalizedException
     */
    public function getXlsFile()
    {
        $component = $this->filter->getComponent();

        $name = md5(microtime());
        $file = 'export/'. $component->getName() . $name . '.xls';

        $this->filter->prepareComponent($component);
        $this->filter->applySelectionOnTargetProvider();

        $component->getContext()->getDataProvider()->setLimit(0, 0);

        /** @var SearchResultInterface $searchResult */
        $searchResult = $component->getContext()->getDataProvider()->getSearchResult();

        /** @var DocumentInterface[] $searchResultItems */
        $searchResultItems = $searchResult->getItems();

        $this->prepareItems($component->getName(), $searchResultItems);

        /** @var SearchResultIterator $searchResultIterator */
        $searchResultIterator = $this->iteratorFactory->create(['items' => $searchResultItems]);

        /** @var Excel $excel */
        $excel = $this->excelFactory->create([
            'iterator' => $searchResultIterator,
            'rowCallback'=> [$this, 'getRowData'],
        ]);

        $this->directory->create('export');
        $stream = $this->directory->openFile($file, 'w+');
        $stream->lock();

        $excel->setDataHeader($this->metadataProvider->getHeaders($component));
        $excel->write($stream, $component->getName() . '.xls');

        $stream->unlock();
        $stream->close();

        return [
            'type' => 'filename',
            'value' => $file,
            'rm' => true  // can delete file after use
        ];
    }

    /**
     * @param string $componentName
     * @param array $items
     * @return void
     */
    protected function prepareItems($componentName, array $items = [])
    {
        foreach ($items as $document) {
            $this->metadataProvider->convertDate($document, $componentName);
        }
    }
}

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

<?php

/**

* See COPYING.txt for license details.

namespace Namespace\Module\Model\Export;

use Magento\Ui\Model\Export\MetadataProvider;

use Magento\Ui\Model\Export\SearchResultIteratorFactory;

use Magento\Framework\Api\Search\DocumentInterface;

use Magento\Framework\Api\Search\SearchResultInterface;

use Magento\Framework\App\Filesystem\DirectoryList;

use Magento\Framework\Convert\Excel;

use Magento\Framework\Convert\ExcelFactory;

use Magento\Framework\Exception\LocalizedException;

use Magento\Framework\Filesystem;

use Magento\Framework\Filesystem\Directory\WriteInterface;

use Magento\Ui\Component\MassAction\Filter;

/**

* Class ConvertToXls

class ConvertToXls

{

/**

* @var WriteInterface

protected $directory;

/**

* @var MetadataProvider

protected $metadataProvider;

/**

* @var ExcelFactory

protected $excelFactory;

/**

* @var array

protected $options;

/**

* @var SearchResultIteratorFactory

protected $iteratorFactory;

/**

* @var array

protected $fields;

/**

* @param Filesystem $filesystem

* @param Filter $filter

* @param MetadataProvider $metadataProvider

* @param ExcelFactory $excelFactory

* @param SearchResultIteratorFactory $iteratorFactory

public function __construct(

Filesystem $filesystem,

Filter $filter,

MetadataProvider $metadataProvider,

ExcelFactory $excelFactory,

SearchResultIteratorFactory $iteratorFactory

) {

$this->filter = $filter;

$this->directory = $filesystem->getDirectoryWrite(DirectoryList::VAR_DIR);

$this->metadataProvider = $metadataProvider;

$this->excelFactory = $excelFactory;

$this->iteratorFactory = $iteratorFactory;

}

/**

* Returns Filters with options

* @return array

protected function getOptions()

{

if (!$this->options) {

$this->options = $this->metadataProvider->getOptions();

}

return $this->options;

}

/**

* Returns DB fields list

* @return array

protected function getFields()

{

if (!$this->fields) {

$component = $this->filter->getComponent();

$this->fields = $this->metadataProvider->getFields($component);

}

return $this->fields;

}

/**

* Returns row data

* @param DocumentInterface $document

* @return array

public function getRowData(DocumentInterface $document)

{

return $this->metadataProvider->getRowData($document, $this->getFields(), $this->getOptions());

}

/**

* Returns XML file

* @return array

* @throws LocalizedException

public function getXlsFile()

{

$component = $this->filter->getComponent();

$name = md5(microtime());

$file = 'export/'. $component->getName() . $name . '.xls';

$this->filter->prepareComponent($component);

$this->filter->applySelectionOnTargetProvider();

$component->getContext()->getDataProvider()->setLimit(0, 0);

/** @var SearchResultInterface $searchResult */

$searchResult = $component->getContext()->getDataProvider()->getSearchResult();

/** @var DocumentInterface[] $searchResultItems */

$searchResultItems = $searchResult->getItems();

$this->prepareItems($component->getName(), $searchResultItems);

/** @var SearchResultIterator $searchResultIterator */

$searchResultIterator = $this->iteratorFactory->create(['items' => $searchResultItems]);

/** @var Excel $excel */

$excel = $this->excelFactory->create([

'iterator' => $searchResultIterator,

'rowCallback'=> [$this, 'getRowData'],

]);

$this->directory->create('export');

$stream = $this->directory->openFile($file, 'w+');

$stream->lock();

$excel->setDataHeader($this->metadataProvider->getHeaders($component));

$excel->write($stream, $component->getName() . '.xls');

$stream->unlock();

$stream->close();

return [

'type' => 'filename',

'value' => $file,

'rm' => true // can delete file after use

];

}

/**

* @param string $componentName

* @param array $items

* @return void

protected function prepareItems($componentName, array $items = [])

{

foreach ($items as $document) {

$this->metadataProvider->convertDate($document, $componentName);

}

Since this approach doesn’t look very merchant-friendly, we’d also like to draw your attention to an alternative solution with XLSX files instead of XLS.

How to export XLSX files from Magento 2

You need a third-party extension to enable the XLSX export in Magento 2. Meet the Improved Import & Export extension! It not only lets you transfer XLSX files from your e-commerce website but also supports such standards as:

CSV;
XML;
JSON;
ODS;
ZIP & TAR.

Besides, the module offers extensive mapping capabilities. You can freely export data in a format suitable for your external integrations. Although you cannot transfer Magento 2 attributes straight to a third-party system, since it has its unique standards and requirements, the Improved Import & Export lets you do that. You either apply a mapping preset or match native Magento 2 attributes to ones utilized by the platform you connect your website to.

Magento 2 attribute mapping import and export

Various data editing capabilities enable you to merge and split data, add suffixes and prefixes, create missing attributes on the fly, etc.

Besides, the Improved Import & Export extension supports data transfer automation. The module launches data transfers according to schedule. At the same time, you can leverage various triggers. Thus, you can export data from Magento 2 in XLSX daily, weekly, or monthly as well as after a particular event – a new order is placed – takes place.

Magento 2 all product types import and export

And for various complex integrations, Improved Import & Export utilizes API connections, creating a robust data flow between your e-commerce store and an external system.

Last but not least, our module has a set of plug-ins that simplify particular integrations. For instance, SAP Business One Integration Add-on for Magento 2 lets you synchronize the two systems within just a few clicks.

For further information about our extension, follow this link:

Get Improved Import & Export Magento 2 Extension

You can find more export and import tips for Magento 2 in our cookbook.

Post Tags:export magento 2 Magento 2 Developer’s Cookbook XLS XLSX

← Previous Post Next Post →

How to export data from Magento 2 in XLS & XLSX formats

Recently, we’ve come across a question by user00247 regarding how to export data from Magento 2 in an XLS format.… Read more…
How to export a custom entity from Magento 2

Let’s assume that you need to export a custom entity from Magento 2 as you do with products, orders, and… Read more…
How to export customers with custom attributes in Magento 2

We continue sifting the endless StackExchange desert looking for the most helpful discussion. This time, our attention has been captured… Read more…
How to export custom SKU column from Magento 2 with all content

Paras Sakariya has added a custom SKU column to a sales order grid. While the corresponding records appear on the… Read more…
Exploring Magento 2 Backend: Import/Export Tax Rates

Tax rate management in Magento 2 is quite a straightforward process if you conduct business locally. However, when you expand… Read more…
How to Export and Import Magento 2 Categories

Categories can also be imported to Magento 2 stores. Learn how to do it with Improved Import and Export extension… Read more…
Firebear Improved Import & Export Plugin for WooCommerce

We already simplify the life of WooCommerce merchants who want to transfer their e-commerce stores to Magento 2, providing the… Read more…
Firebear Improved Import & Export Plugin for Oracle Commerce Cloud

We already provide extended integration capabilities for Magento 2 and the Oracle ecosystem with our NetSuite Integration Add-on for Magento… Read more…
Firebear Improved Import & Export Plugin for Salesforce Commerce Cloud

The Firebear portfolio already includes the Magento 2 add-on for the Salesforce CRM integration that works on top of the… Read more…
Firebear Improved Import & Export Plugin for Squarespace

Today, we want to describe one of our new projects - the Firebear Improved Import & Export Extension for Squarespace.… Read more…
Firebear Improved Import & Export Plugin for Shopware

Our Improved Import & Export module is one of the most fully-featured and powerful data transfer solutions in the entire… Read more…
Manual for NetSuite Integration Add-on for Magento 2 of Improved Import

This is an add-on of Improved Import and Export extension for Magento 2. With the NetSuite integration add-on, you can… Read more…
How to Export Products from Magento 2 via CLI

If you want to export products from Magento 2 using the command-line interface, you've come to the right place. In… Read more…
Magento 2 Backend Exploration: Magento 2 Export vs Improved Export

We've just described why the native Magento 2 import solution is not worth your attention. But what about the corresponding… Read more…
How to Import Database in Magento 2

Recently, we've spotted a question on StackExchange regarding database import. David Duong faced problems while transferring a database on Magento… Read more…
Magento 2 Backend Exploration: Orders

In the following article, we teach you how to manage the Orders screen, add new orders on behalf of your… Read more…
Magento 2 search terms and synonyms, and how to import and export them

Magento 2 allows the store administrators to optimize the customer search queries by composing lists and search terms and synonyms.… Read more…
The Complete Guide to Magento 2 Related Products, Up-sells, and Cross-sells, and how to import them

The triplet ‘related products, up-sells, and cross-sells’ can be called ‘a promo engine for an e-store’. The products are distinguished… Read more…
How to import and export CMS/Static Blocks to Magento 2

In this article, you will learn how to import static blocks (or CMS) blocks to your Magento 2 store and… Read more…
How to import and export Magento 2 MSI and how it works. Magento 2 multi source inventory (MSI) import guide and manual

Magento version 2.3 came out with the long awaited Multi-Source Inventory (MSI) support. The feature is available right after installing… Read more…

Understanding xls and xlsx

How to export XLS files from Magento 2

How to export XLSX files from Magento 2

Related posts