![Syde [formerly Wyomind]](http://www.syde.shop/cdn/shop/files/logo_noir.svg?v=1790605670&width=118){kind=logo}
![Syde [formerly Wyomind]](http://www.syde.shop/cdn/shop/files/logo.svg?v=1790605675&width=118){kind=logo}
Mass Order Update
From Magento 2, the orders are managed as a structured group of data that are shared in different database table instances.
There are several instances from which the main one is the Order table that contains the summary of all the orders that have been placed (date, total amount, tax, customer...).
There are also 3 sub-instances that concern the order details. Those instances describe which products have been ordered and give details about the customer's addresses:
The 4 following sub-instances help to store the different steps in the order process:
Mass Order Export will help you to extract much more data from your Magento 2 database.
Mass Order Export allows you to export all the orders data from your Magento 2 admin into XML or TXT/CSV files. These files can then be transferred into your CRM/ERP software or can be used for reporting purposes.
The way the Mass Order Export extension deals with the orders data is very simple. When configuring your export profile, you have to complete a pattern in which you can use static and dynamic values.
Static values are data that don't change from one order to another and that are added in the output file to make it readable whereas Dynamic values are data that are different for each order such as price, address, the product ordered...
To add the dynamic values to your pattern, you need to use a specific syntax as in the example below.
For example, you want to export all the orders placed into your Magento 2 website and you want to get a simple TXT file including the order id and the total amount of each order.
#123456789 $150.00
#234567891 $275.00
#345678912 $450.00
In your pattern, you should then copy:
#{{order.increment_id}} ${{order.total_paid}}# and $ are static values while {{order.increment_id}} and {{order.total_paid}} are dynamic values that change for each order and that refer to the Order instance.
Mass Order Export includes a full library of all data available for all instances: order, products, payment, invoice, shipment, credit memo...
Mass Order Export is quite easy to use. You'll need to follow 4 steps to configure your extension for Magento 2. Once these steps completed, your extension will be ready to use.
To configure Mass Order Export for Magento 2, you need to go to:
Stores › Settings › Configuration › Wyomind › Mass Order Export
There you get two subtabs.
Mass Order Export allows you to enable cron job reporting.
You have the possibility to send these generation reports to email addresses (they must be separated by a comma).
You can also change the report name as you want.
In that tab, you will be able to enable the log files.
You will also have the possibility to automatically execute profiles when an order is placed by filling the profile ids that you will find in:
Sales › Mass Order Export › Profiles
In the case where the grid is already overwritten by another module, you'll be able to easily modify the orders grid to override.
During that step, the different tabs that can be found in the configuration of a profile will be described. First, the profile configuration will be detailed followed by the different kinds of templates, the filters that can be created to adjust your configuration, the different storage outputs, and the cron schedule in order to automatically generate the profile.
You can create or edit an existing profile from:
SaleS › Mass Order Export › Profiles
Mass Order Export provides you a tool to help you configure your profiles as you want. When editing a profile you'll find a toolbox on the right of the window.
The toolbox is inevitably a very useful tool. This will help you to configure your profiles more quickly.
Here are the different options of the black box.
When creating or editing an export profile in Mass Order Export, you have to be aware of some basic settings.
You can start with the file configuration of the file.
file
file.txt
2019-07-03-file.txt
file-2019-07-03.txt
In that section, define how you want the file to be exported.
To export all the orders, you can leave this field empty.000000002
Exported to
ERP/CRM export/import
When this option is set to YES, two new fields are added to the configuration:
Processing
If you don't want to add any message, you can leave this field empty.Order exported
In the Filters tab, you can define the types of orders and customers you want to include in your export profile. You have also the possibility to create more advanced filters that will best meet your needs.
In this tab, choose the store view from which to export the orders. At least one store view must be selected
This section allows you to specify the type of order you want to export. At least one status must be selected.
In this tab, choose the customer group of the orders you want to export. At least one customer group must be selected
In that tab, you can create more precise filters. For example, you can choose to export only one specific order by setting a filter:
order > increment_id | = | ID of your order
You can also export orders placed by customers whose last name ends with 'son':
order > customer_lastname | like | %son
You have a choice between several options:
In this tab, you'll be able to configure your profile template according to your needs. Mass Order Export allows you to create different kinds of file:
You can select the XML file type.
An XML template is made up of 3 parts:
<orders>
<order>
...
</order></orders>
The XML structure allows you to use iterative syntax in different parts of the template, as follows:
<items>
<?php foreach($products as $product): ?>
<item id={{product.item_id}}>{{product.name}}</item>
<weight>{{product.weight}}</weight>
<?php endforeach; ?>
</items>In most cases, orders contain more than one product, so it may be useful to create an iteration that loops for each ordered product. All the content between the opening and closing markers will be repeated for each product and all dynamic values will be replaced:
<?php foreach($products as $product): ?>
...
<?php endforeach; ?>These iteration markers can be used for all order instances:
<?php foreach($payments as $payment): ?>
...
<?php endforeach; ?>
<?php foreach($invoices as $invoice): ?>
...
<?php endforeach; ?>
<?php foreach($shipments as $shipment): ?>
...
<?php endforeach; ?>
<?php foreach($creditmemos as $creditmemo): ?>
...
<?php endforeach; ?>The file type can be CSV, TXT, TSV, or DIN. You have the possibility to create basic or advanced files.
The template tab will be updated to match the file type you've selected.
Basic file format
Basic format for txt-like files consists of one optional header and several rows applying the same pattern.
The main difference with the XML mode is that you can't use any iteration instructions. Instead, Mass Order Export uses an auto-consolidation internal process. This simply means if you try to get the value of any attribute of an instance (product for example) that contains several items, then the extension will automatically duplicate the TXT/CSV line for each item.
With the following configuration:
Logically the module should export one line for each order, but some orders may contain several product items. The extension will create several lines for the same order, as in the following output example:
Order# Product Name Product Sku
#10000001 my product A AAA
#10000001 my product B BBB
#10000001 my product C CCC
#10000002 my product D DDD
#10000003 my product B BBB
#10000003 my product E EEE
...
Advanced file format
Advanced format for txt-like files consists of a complex file structure divided into several blocks.
This format allows you to use iterative syntax in different parts of the template, as follows:
<?php foreach($products as $product): ?>
PRODUCT=
{{product.sku}}
{{product.qty_ordered}}
{{product.base_row_total output="number_format($self,2)"}}$
<?php endforeach; ?>With Mass Order Export, you have many possibilities to export your profiles.
The first solution is to store your file directly on your server.
You can also configure the FTP settings in order to upload the generated profile to an external FTP server. For example:
wyomind.com
/var/export/ftp
Finally, you can choose to send your profiles by email. Don't forget to separate the email addresses with a comma.
You have the possibility to check the email by clicking on Test Email.
A popup will confirm that the email has been sent.
In that tab, you can choose the days and hours when you want your profiles to be generated.
Now that your profiles are configured, you can export your orders into these files.
From your Magento 2 back office, you will be able to see to which profile each order has been exported, in:
Sales › Operations › Orders
For each order, different notifications will be displayed in the Exported to column:
You can export your orders to anyone of your profiles via several ways.
Every time a profile is generated, the orders that are matching with the profile configuration are automatically exported to that file. From the Magento 2 back-office, choose a profile and simply select the Generate option from the Action dropdown, in:
Sales › Mass Order Export › profiles
A message is displayed and indicates how many orders have been exported to the file.
You can generate a profile using the below command line:
bin/magento wyomind:ordersexporttool:export [profile_id]This allows you to run a profile using its ID.
For example:
bin/magento wyomind:ordersexporttool:export 5If you don't know the ID of the profile you want to execute, you can run the below command:
bin/magento wyomind:ordersexporttool:listThis will list all your export profiles as well as their IDs.
Choose an order and click on View from:
Sales › Operations › Orders
There you can select a profile for each product of the order. For example: txt_sample for a product and xml_sample for another one.
If you go back to:
Sales › Operations › Orders
In the Exported to column, the order displays:
→ txt_sample
→ xml_sample
This means that the order will be exported to those profiles.
Now go back to the order View and click on Export.
Note that the order will be exported to the profile(s) you've defined only if the order is matching with the configuration of the profile.
2 options are interesting in the Export Options of the Configuration tab of your profile, from:
Sales › Mass Order Export › profiles
If you don't want to export several times the same orders, you can define both options on YES. Then only the unmarked orders will be exported.
If at any time, you want to export a new time an order that has already been exported, you have the possibility to unmark that order by clicking on the cross next to the profile name in:
Sales › Operations › Orders
Then, when the profile will be run, the order will be exported a new time.
With Mass Order Export you can create your own custom variables and functions. You'll find examples in the following documentation that will help you to customize your profiles for Magento 2.
In some cases, you might need to get the value of one attribute that is not available in any of the default instances (order, product, address, payment, invoice, shipment or credit memo) or you might need to use the value of one attribute but with a computed output.
Mass Order Export allows creating your own customized variables directly from your Magento 2 admin panel by using some PHP code.
To create a custom variable, click on Add new from:
Sales › Mass Order Export › Custom variables
Below are some examples of customized variables.
Scope = Product
Name = description
Comment = Retrieve the description of each product.
PHP Script =
<?php
$om = \Magento\Framework\App\ObjectManager::getInstance();
$model = $om->get('\Magento\Catalog\Model\Product');
$product = $model->load($item->getProductId());
return $product ->getDescription();
?>Scope = Order
Name = skus
Comment = Retrieve the sku of each ordered product.
PHP Script =
<?php
$skus=array();
foreach($order->getItems() as $item){
$skus[]=$item->getSku();
}
return implode(", ",$skus);
?>
Once you've created the custom variable, you can insert it into your XML or CSV file template.
For example, to get the SKUs of all the products that have been ordered, add to your file template:
{{order.skus}}
Mass Order Export also gives you the possibility to create your own custom PHP functions.
To do so, click on Add new from:
Sales › Mass Order Export › Custom functions
You should now add your custom function in the PHP script field as follows:
<?php
if(!function_exists("example")){
function example($self,$argument_1,$argument_2){
... do something with the arguments...
return $something;
}
}
?>The variable $self represents the value of the attribute called when you use the custom function.
Here is an example of a custom function:
<?php
if(!function_exists("parseDate")){
function parseDate($self,$format){
return date($format,strtotime($self));
}
?>
Once you've created the custom function and clicked on Save, you can insert it into your XML or CSV file template.
A custom function can be used in the template as follows:
{{any.variable output="example($self,'value 1','value 2')"}}For example, to retrieve the formatted creation date of the order, add to your file template the below code:
{{order.created_at output="parseDate($self,'m/d/Y')"}}
This extension works with Magento Community Edition and also Magento Enterprise Edition. To know if Mass Order Export is compatible with your Magento version, please check the Compatibility tab.
Magento offers three variations of its product.
As their names have changed over the past few years, here is a recap:
A license is valid for an unlimited period of time on one single installation
You can pre-register your live domain to your license in advance.
Thanks to this option, you'll be able to get the module ready to use on your domain before it goes live.
To pre-register your production domain:
One license is valid for an unlimited period of time on one installation only. However, it is possible to extend or transfer your license in 2 cases:
To be able to use Mass Order Export on both your production and testing environments, follow the instructions below:
In order to download Mass Order Export, log into your Wyomind account:
A new window opens.
Only the latest extension version released within your Support & Upgrade period is available. In order to get the very latest extension version make sure your Support & Upgrade plan is up to date.
When purchasing a module from wyomind.com, you benefit from 12 months of upgrade. Within this period you can at any time download the latest version of the module directly from your account.
To upgrade Mass Order Export, follow the steps below:
You can install Mass Order Export manually.
bin/magento setup:upgrade If you are using a production mode, execute also:
bin/magento setup:static-content:deploy bin/magento setup:di:compile You can install Mass Order Export using Composer software in two cases:
composer config repositories.wyomind composer https://repo.wyomind.com composer require wyomind/ordersexporttoolbin/magento setup:upgrade bin/magento setup:static-content:deploy bin/magento setup:di:compileTo uninstall Mass Order Export, start with disabling the extension running the following command:
bin/magento module:disable Wyomind_OrdersExportToolThen, you have 2 ways to uninstall the extension depending on how the extension has been previously installed:
Run the ordersexporttool-uninstall.sh file (you can find it in the extension zip folder) from your Magento root directory:
sh ordersexporttool-uninstall.shRun the below command line:
composer remove wyomind/ordersexporttoolOnce the uninstallation is over, refresh your cache and enable the compiler back again (if you use it).
You can install Mass Order Export via Web Setup Wizard if you purchased it from Magento Marketplace only.
To know how to proceed, all steps are described in the link below:
http://docs.magento.com/m2/ce/user_guide/system/component-manager.html
Next step is to activate your license:
Extension activation
Once Mass Order Export is installed, you have to activate the license. For previous versions, you can activate the license from your back-office:
<?php
return array(
'backend' => array(
'frontName' => 'admin'
),
'crypt' => array(
'key' => '1e8f3c6772b7a6a6689c3c8cefa4ccf0'
),
/* ... */
)
?>
Add another domain to your license
To activate the license on another domain (test, staging...):
Note that the order in which you activate your license on your domains does not matter. You can start with your staging/dev/local environment or with your live domain, the process will be the same.
Also, if you have loads of staging domains, or if you are an agency managing load of domains for your customers, please contact us so that we can automatically whitelist these domains.Once Mass Order Export is installed, you have to activate the license.
For this, you can use the below command line (change the Activation key with the corresponding value):
bin/magento wyomind:license:activate Wyomind_OrdersExportTool <YOUR_ACTIVATION_KEY>To retrieve the list of all the available modules as well as the licenses status, please use:
bin/magento wyomind:license:statusAmong the different status, you can find:
To activate several licenses at the same time, use:
bin/magento wyomind:license:activate \
Wyomind_Extension1,Wyomind_Extension2 \
ACTIVATION_KEY_1,ACTIVATION_KEY_2or:
bin/magento wyomind:license:activate \
Extension1,Extension2 \
ACTIVATION_KEY_1,ACTIVATION_KEY_2You have the possibility to open the generated CSV file with any spreadsheet application.
While opening your data feed, you need to make sure to select the delimiter options that correspond with your data feed configuration from your Magento 2 admin.
For example, if you've chosen semi-colon as Fields delimiter, then you'll need to open the file choosing ";" as field delimiter as well as if you've choosen double quotes as the Fields enclosure, then you'll have to make sure that you've selected the same character.
Note that the Excel application won't show this popup when opening the file.
It's possible to use the IF/ELSE statements by using some php code.
For example, if the billing country id is Belgium return 8000 else 8001.
<? if ("{country_id billing}" == "US") return "8000"; else return "8001"; ?>To retrieve state/region from the shipment address of a customer:
{country_id shipping}/<? return Mage::getModel('directory/region')->load({region_id shipping})->getCode(); ?>For example, if the shipment address is located in California, then this will return: US/CA.
If you want to retrieve "France" instead of "Fr", you'll need to use:
<? return Mage::app()->getLocale()->getCountryTranslation("{country_id shipping}"); ?>Mass Order Export offers you many possibilities to export your orders. You can set filters according to your needs. In the Filters tab of your profile configuration, you'll find 3 subtabs.
Order status
Select the types of orders you want to export. For example choose to export pending, processing and complete orders.
Customers group
In that tab, you can select the customers group of the orders you want to include in your data feed. For example choose to export orders placed by general and not logged in customers only.
Advanced filters
In that tab, you can create more precise filters. For example, you can choose to export only one specific order by setting a filter:
order > increment_id | = | Id of your order
You can also export orders placed by customers whose lastname ends with 'son':
order > customer_lastname | like | %son
You have the choice between several options:
You can use regular expressions in the advanced filters. For example, with the Advanced Inventory extension, it can be useful to filter the orders and products that have been assigned to a particular store.
Instead of a unique store name, you can use a regular expression that will make the profile dynamic.
For example:
Order > assigned_to regexp (,|^)(1)(,|$)
Product > assigned_to regexp (,|^)(1)(,|$)
That expression will take into account all orders and products assigned to a store.
In Orders Export Tool, you can specify FTP settings to upload your file.
From the Magento 2 admin, select a file and go to the Output tab. There you have 3 options to export your profile. If you choose to enable the FTP settings, here is how to configure each field:
wyomind.com
/var/export/ftp
The file is uploaded each time the feed is generated manually or automatically.
With Mass Order Export, you can now define the encoding type of your files and choose to export them using UTF-8 with or without BOM.
BOM stands for Byte Order Mark and are the first 3 bytes of a file.
If there's no BOM, then the encoding type will be implicitly detected according to the file. On the contrary, BOM allow to declare the encoding type very clearly.
Mass Order Export provides you with a fully configurable schedule in the Cron Schedule tab of your pattern configuration for each data feed or profile.
So that it works, you need to have one main scheduled task running from your server side and targeting cron.php located in the pub directory of Magento 2 root directory (ideally every hour).
If the management panel from your hosting compagny doesn't provide such a service, you should be able to use a remote service such as: http://www.mywebcron.com
Mass Order Export also provides you with a cron job reporting, so that you can get email reports on each data feed or profile you're generating.
Here is the process to download your file:
This issue may be due to a problem during the installation process.
You will be able to fix it by following these steps:
Be careful, that entry depends on your extension. For example, if you have the extension called Simple Google Shopping, you should delete Wyomind_SimpleGoogleShopping.
If you are working on Magento 2.0.x, you'll have to rename:
Wyomind\OrdersExportTool\view\adminhtml\ui_component\sales_order_grid_Mage_2.0.xml
into:
Wyomind\OrdersExportTool\view\adminhtml\ui_component\sales_order_grid.xml
If your profile doesn't seem to be uploaded via FTP, it can be due to an incorrect configuration or to a problem from your server. Make sure that:
Here is an example of FTP configuration for Mass Order Export on Magento 2:
PHP features are disabled by default in Mass Order Export.
If you're using PHP parameters in your variables or inline script in your patterns (<?php return ... ?>), you'll get an error saying: "PHP features are disabled".
In order to be able to use PHP script in your variables and patterns, you must make some modifications in:
app/code/Wyomind/OrdersExportTool/Helper/Data.php
Replace:
public function execPhp($script, $order = null, $data = array(), $item = null)
{
return "Php features are disabled. In order to activate them please have a look at : https://www.wyomind.com/magento2/orders-export-tool-magento.html?section=faq";
}with:
public function execPhp($script, $order = null, $data = array(), $item = null)
{
return eval($script);
}PT
We use XML to export orders from Magento and it is working well for us. It is almost three+ years we have been using it. I would recommend this product if you have a Magento store and need to export order to sync with some other system.
James
We are delighted with the Mass Order Export extension, it has saved us many hours of manual order processing and we couldn't function without it now!
Mark Manshanden
We use Wyomind's mass order export for a variety of uses. But the most important ones are: double check on the purchase invoices. Did we sell what we purchased and can the differences be explained. Further more we sell across different countries so need to do some paperwork to have our products cross the border. With Mass order export it is a piece of cake to export both order product information and self added constant values which relate to the different countries. The import/export information is automatically generated and distributed to our bookkeeping and customs department.
Peter T
Wyomind order export tool is working great for our website. we are using wyomind extensions more than 5 years for different websites. The order export tool extension have amazing functionality and meet your requirements. The Order export extension gave us access to all the order data we needed along with very flexible custom attributes. The choice of data delivery by a number of different methods and timed schedules was also very useful. Requests to Wyomind were responded to quickly and efficiently. solid and totally versatile piece of software absolutely useful for your M2 store.
Paul S
Being able to export all the orders into a CSV file is pretty essential for the way our business works, we can easily pass this information to our accountant. The 2 things I love about this plugin the most is the support and the flexibility. Having the ability to build my own own profile to export the exact data I need is really good, they provide you with all the info needed to do this. It's also possible to add data from other 3rd party plugins, you can do this using PHP staright within the admin, that makes this plugin super powerful. Previously I was using a similar plugin from another company with Magento 1, it was good but unfortunately the support was not available. Wyomind will go above and beyond to make sure the plugin works as advertised, keep up the good work guys!
Nicolas
Ce module est excellent pour mes exports comptable et tracking. Je l'utilise aussi pour du dropshiping. Le support est au top ! Ne pas hésiter.
Kimmo Räntilä
We had a problem with a script to find the orders we needed. Jean-Paul gave excellent superfast support. Now it works perfectly. Thanks!
Kimmo Räntilä
This extension has been great. We have used it to get a list for Intrastat export reports and find orders with certain products. Thanks.
Jelle
My client has been using the Magento 1 version of this extension for years. So it is needless to say, we needed it for Magento 2 too. The tool is fast and flawless. It's very flexible, as was the Magento 1 extension. Never had any issue with the support either. They're fast in responses!
Daniela Buehrig
The data Mass order export extension is easy to use and to implement. Have used this extension for M1EE and for M2EE and currently is in use for M2EE 2.3.5. However, with the upgrade to 2.3.5 we see some inconsistencies in performance. Nothing that can't be solved, it just requires a bit of time and effort to get it to work again. Whilst the last version was easier to configure, the current version allows more flexibility as you can create unique data comands.
Peter
Have used this extesions for more then 3 years on M2 and many more years on M1 and works really good. Can take some time to load big feeds and can also be a bit buggy when upgrading. But overall I would say its a good module that allow you to get the customized data you need.
Carlos
I've been using this extension for more than 4 years and it has been very useful for our eCommerce. The option of using PHP script to get customized data from the system is a great differential for us. Recommended.
Nicola
excellent for exporting orders to invoicing management systems, great extension and great assistance
Scafflaw
Great extension with lots of flexibility to get the export file you need.
KaffeTilbud.dk
If your webshop in magento starts to run a bit and you are in a market with many competitors, the price pressure is high and the margins are low. With many orders and weekly price adjustments, it is difficult to monitor the overview of profitability. Thanks to Wyominds export tool, we can. The weekly export gives us a direct overview of how much we have left over per order and what the webshop has delivered last week. That gives you peace of mind.
Thiago
Our store needed to export orders in different formats to integrate sales data with ERP, CRM and the post management system. All of this was possible with the Order Export Tool module. Today we have a data export profile for every need, working perfectly.
daniela
The extension is very easy to implement and it works without any problems. The support team is super responsive and try to action things as soon as possible. The extension does exactly what is promised.
Paul
Great extension, works as expected. If there are any technical issues support staff are very good
Ben
Excellent extension which has endless power and customisation. Any questions and support team are there to help
Tait
We've been using Wyomind extensions for years and always have great support. The Order Export module is superb and allows so much flexibility. The support team are always quick to react and help us to resolve any issues.
How merchants put Mass Order Export to work, step by step.
Initial release for the master version
Initial release for the legacy version
Security improvement
Minor fix for the compilation
Improvements :
Specific needs or any ideas of enhancements and new features to add to the extension? Tell us more, we'll get back to you shortly!
