Mass Order Update

Features

The Mass Order Update extension for Magento 2 will allow you to update massively your orders via CSV or XML files imported manually or automatically from any order management software/platform.

Mass Order Update makes it possible for you to manage:

• order information: change the status and add a comment
• delivery: create a shipment and add a tracking number
• order processing: create the invoice, the credit memo, and cancel the order

Configuration steps

The extension is very easy to use:  

1. Create an import profile
2. Set the import file
3. Define where the order identifier is in the file
4. Define if the identifier is the order id or the increment id
5. Create your rules
6. Execute your profile or configure an automatic execution

In the case where you don't want to apply the rule to all the orders, you have the possibility to add some conditions to it. You could also create logical combinations of conditions to manage more complicated cases. In fact, the conditions allow you to define whether or not you apply the actions of the rule to the orders.  

General Settings

You can configure the general settings from:
Stores › Settings › Configuration › Wyomind › Mass Order Update

Log

To activate the log file, set Enable log on YES.

Profile

You can also configure:

• Number of rows in mapping preview
  It is the number of rows that will appear in the preview box.
  

  2

  

• Number of orders loaded and processed at once
  Your profile will process the import file by batches and limit memory consumption.
  This parameter defines the size of each batch.
  

  100

Cron job

To activate the cron job reporting, set Enable cron job reporting on YES. If set to yes, the Mass Order Update module will send a report email on each execution.

You'll have to configure: 

• Sender Email
  The email of the sender.
• Sender Name
  The name of the sender.
• Send the reports to
  The recipients of the email.
  Note that emails must be separated with a comma.
  

  email1@mail.com,email2@mail.com

• Report title
  A title for the report and the email.

You can also define:

• a Cron Interval
  

  By default, cron tasks can be scheduled for each period of 30 minutes.
  If you need a more precise hour, you can change that interval.
  

  20

The Tool Box

The toolbox is very useful as this will help you to configure your update file more quickly.

Below are the different options for the toolbox.

Input Data

Output Data

You can have different notifications among which:

• Order not found
  The order cannot be found among your Magento instance.
• Order is not...
  The order cannot be shipped, invoiced...
• Conditions not fulfilled for rule ***
  The order doesn't meet the conditions for the rule.
• Trying to ...
  The order meets the conditions for the rule, and the action will be performed on the order.

Settings

Import Profile Settings

Define the settings for your profile.  

• Profile Name
  The profile's name must be unique.
• Filter lines
  Leave empty to import all lines:
  

  means all lines will be imported

  
  Type the numbers of the lines you want to import, making sure to separate each line or range with a comma (,):
  

  2,4,6,8,10

  means lines 2,4,6,8,10 will be imported

  
  Use a dash (-) to denote a range of lines:
  

  8-10

  means lines 8,9,10 will be imported

  
  Use a plus (+) to import all lines from a line number:
  

  4+

  means all lines from line 4 will be imported
  

  
  Use regular expressions surrounded by # to indicate a particular group of identifiers to import:

  #0000002[0-9]+#
  

  means all lines with an identifier matching the regular expression will be imported

File Location

This section allows you to specify where the source data file is stored. You have several options:

• Magento File System
  The file is stored in the Magento root directory or a subdirectory of the Magento root directory.
  The File path is relative to Magento root folder.
• FTP server
  The file is stored on a remote server available from FTP or SFTP. Do not prefix the domain name or the IP with FTP://.
  You'll be able to check if the FTP connexion is valid.
  The File path is relative to FTP user root folder.
• URL
  The file is stored on a remote server available from HTTP or HTTPS.
  Fill in the File path with the URL of the file.
• Webservice
  The file is available on a remote server accessible as web service.
  Fill in the File path with the URL of the web service.
  The extension uses the CURL PHP library to connect the web service. You can provide the web service a login/password couple and any parameters formatted as url parameters, as follows:
  

  parameter1=value1&parameter2=value2&parameter3=value3

• Dropbox
  Fill in the File Path with the URL of the dropbox service.
  Generate your token from your Dropbox account https://www.dropbox.com/developers/apps

• File path
  The path to the file including the file name and the extension as it appears in the file system of the server. 
  You can also use regular expressions in the file paths. 

Order Identification

Choose how your orders will be identified in the imported file:

• Order identification
  You have the possibility to choose the order id or the order increment.
  For example:
  

  3420

  or
  

  1000003421

• Identifier offset
  You need to select the field which contains the order identifier.

File Type

This allows you to specify the file type used for the update between XML and CSV.

For CSV files, define:

• Column separator
  Define the column separator.
• Text delimiter
  Select the text delimiter.
• The first line is a header
  Specify when the first line is a header.

For XML files, define:

• Xpath to orders
  In case of an update from an XML file, fill in the XPath that targets the orders. The Xpath is case sensitive.
• XML structure
  You have two options; the Automatic detection or the Predefined structure.
  The automatic detection fits for simple files made of only one nesting level such as the above file sample.
• Predefined structure
  If you've selected the Predefined structure, you have the possibility to define your own file structure. When the structure of your file is quite complex, the info may be dispatched in deep nodes and sometimes in tag attributes such as:
  

  url="something"
  

  
  
  Below is an example of complex file where you need a predefined structure:
  

  <orders>
   <order>
    <CustomerOrderId>000000028</CustomerOrderId>
    <order-shipment>
     <OrderTrackingNumber>334678MCLK</OrderTrackingNumber>
     <OrderCarrier>ups</OrderCarrier>
     <OrderTrackingURL>https://www.fedex.com/apps/fedextrack/?action=track&amp;trackingnumber=334678MCLK&amp;cntry_code=us&amp;locale=en_US</OrderTrackingURL>
    </order-shipment>
   </order>
  </orders>
  

  The XPath that targets the orders in the above file is /orders/order

  The JSON syntax you need to use is:
  

  {
  "incrementid":"CustomerOrderId",
  "tracking_number":"order-shipment/OrderTrackingNumber",
  "carrier":"order-shipment/OrderCarrier"
  }

Post Process Action

You have the possibility to define an action after the file is processed.

• Action
  Do Nothing
  Delete the import file
  Move import file
• Move to folder
  Define the file path where you want to move the import file, relative to your Magento root folder.
  

Rules

In that section, you can define your own rules and give them a Rule name. 

A rule is a combination from 0 to n conditions and from 1 to n actions. Rules are tested for each order corresponding to an element of the file. If the conditions are met for the current element, the actions of the rule will be executed for the order.

If there is no condition for a rule, the actions are always executed for the order.

Overview of the interface

Find below a quick overview of the Rules section. 

1. Enable or disable a rule by clicking on the LINK symbol.
2. Apply a label to the rule.
3. Add a condition to your rule by clicking on +. 
4. Delete a condition from the rule.
5. Add a new action. 
6. Delete an action from the rule.
7. Change the order of each row using the drag and drop.
8. Apply a label to the action.
9. Apply the color of your choice to the action.
10. Apply a custom script </> to the action options.
    These scripts can be previewed in the output. 
    See how to use the PHP API.
11. Preview your file by clicking INPUT DATA.
12. Check the actions that will be performed on your orders by clicking Execution preview.

Conditions

You can define conditions based on:

• the file: the conditions are based on the data available in the source file
• the order: the conditions are based on the orders data

You have the possibility to define conditions according to several options such as:

• EQUAL / NOT EQUAL
• GREATER / LOWER
• GREATER OR EQUAL / LOWER OR EQUAL
• LIKE / NOT LIKE
• IS NULL / IS NOT NULL
• IN / NOT IN

Actions

You can select the below actions: 

• Set status
  You will have to select the status you want to apply to the orders. 
  

  

• Add comment
  You can define the comment you want to add to the orders as well as if you want to send the comment email and make the comment visible on the front-office, in the customer account.

  

• Invoice
  You can define if you want to send the invoice and the email.
  

  

• Creditmemo
  You can define if you want to send the credit memo and the email.
  

  

• Ship
  Define the carrier to apply, the title, the tracking number, the source to use (when MSI is enabled), and if you want to send a shipping email.
  

  

• Cancel
  Define if you want to cancel the orders. 
  

  

Scheduled Tasks

You can schedule the profile to be executed for all days of the week and with a default interval of 30 minutes between each execution.

The cron interval can be configured in the General Settings from: 
Stores › Settings › Configuration › Wyomind › Mass Order Update