Mass Product Import & Update

Mass Product Import & Update allows you to update or import massively products in Magento in a record time thanks to CSV and XML files available from your website's server, from remote servers through FTP or HTTP.

Mass Product Import & Update allows you to create and/or update the below product attributes for all store views or specific store views:

• All system attributes (SKU, type, attribute set, visibility, status)
• All product attributes created within Magento (input, dropdown, yes/no, multi-select, text...)
• All product image attributes (image gallery, base image, thumbnail, small images... )
• All stock attributes (qty, availability, backorder, manage stock, low stock notification…)
• Categories associated with products
• Prices, special prices, special price dates, tax class…

How to configure Mass Product Import & Update

Configure Mass Product Import & Update in a general way

General Settings

To configure Mass Product Import & Update in a general way, you have to go in:

Stores › SETTINGS › Configuration › WYOMIND › Mass Product Import & Update

Log file

Enable log
Allows you to activate the log file available under the var/log directory. The file is named Wyomind_MassProductImportAndUpdate.log.

M2E Pro update

Notify M2E Pro globally about some change in products
If enabled, updates are transferred to M2E Pro whatever the modification is. If disabled, the module will only notify M2E Pro that there is an update if the price or the quantity changes.

Mapping preview

Number of rows in mapping preview
Allows you to define the number of rows returned in the browser data of the preview when editing a profile.

Cron job reporting

With Mass Product Import & Update, you have the possibility to enable cron job reporting. 

• Enable cron job reporting
  Allows you to define whether you want to enable the reporting or not in order to get notified each time a profile runs and if an error happens. The more important is the number of rows, the more the load time increases. A good compromise could be 1000 rows.
• Sender Email
  Type the email of the sender. 
• Sender Name
  Define the name of the sender. 
• Send the reports to
  Specify the email addresses to which the report must be sent. Emails must be separated with a comma (,). 
  
• Report title
  Define your own title for the report. 

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 in the Cron interval field. 

Create an import profile with Mass Product Import & Update

With Mass Product Import & Update, you can update Magento products or create new ones.

For this, edit one of the sample profile patterns or create a new profile by clicking CREATE A NEW PROFILE from:
System › Data Transfer › Mass PRODUCT IMPORT & Update

Black Box

The black-box is a tool that will help you configure your mapping seamlessly. It is composed of 3 major features.

Input Data

To get a preview of the input data, click on  INPUT DATA.

Library

The library allows you to check what are the values you can use for each attribute. You will also find some examples to help you.

Output Data

Clicking on OUTPUT DATA will give you a preview of the data as they'll be updated. 

Settings

In this section, you will be able to define the source of the data.

Profile settings

Define the settings for your profile.  

• Enabled
  You can enable/disable the profile.
  Note that the profile is disabled by default when it results from a duplication.
  
• Profile Name
  Only alphabetic and number are allowed + hyphens (-) and underscores (_).
  The profile's name must be unique.
• SQL mode
  When SQL mode is enabled, no data are updated. Running the profile will only produce a SQL file. This file could be executed directly in your database manager.
  If you activate SQL mode, you'll need to fill in several fields:
• SQL file name
  Name of the SQL file to generate.
  

  XML_sample.sql

• SQL file path
  Is the path where the SQL file will be generated (relative to Magento root folder). 
  

  var/sample

• Profile method
  You can choose the action that the profile will trigger:
  Update products only
  Import new products only
  Update products and import new products
• Filter lines
  Leave empty to export all lines:
  

  e.g:

  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 (,):
  

  e.g: 2,4,6,8,10

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

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

  e.g: 8-10

  means lines 8,9,10 will be imported

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

  e.g: 4+

  means all lines from line 4 will be imported

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

  e.g: #ABC-[0-9]+#
  means all lines with an identifier matching the regular expression will be imported 

When the Profile method option is on Update products and import new products, in the Mapping & Rules tab, you can define for each Target attribute dropdown if the value applies to the new products, or/and to the existing products:

• New products only
• Existing products only
• Both, new and existing products

File Location

This section allows you to specify where the source data file is stored and what is the file path including the file name and the extension as it appears in the file system of the server. Note that you won't be able to save the source file path if the path is invalid.

You have several options:

• Magento File System
  The file is stored in the Magento root directory or a subdirectory of the Magento root directory.
  File path relative to the Magento root folder.
  See how to use regular expression in the file name.
• 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 the FTP user root folder.
  You can also use regular expression in the file name when it is stored remotely via FTP.
  
• URL
  The file is stored on a remote server available from HTTP or HTTPS.
  

  The file path is the URL of the file.
  

  http://www.website.com/Inventory/AvailableInventory

    
  If you' are using HTTP authentication, you must add the login and the password before the URL in the below format:

  http://login:password@www.website.com/Inventory/AvailableInventory

  If you are using a specific port, you can use the below format:
  

  http://login:password@www.website.com:port/Inventory/AvailableInventory
  

• Webservice
  The file is available on a remote server accessible as web services.
  The extension uses the CURL PHP library to connect the web service.
  The file path is the URL of the web services.
  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
  You can generate your token from your Dropbox account https://www.dropbox.com/developers/apps
  The file path is the URL of the dropbox service.
  

Verify SSL certificate

For the URL and Web service locations, the extension checks the SSL certificate of the server of an https address, and that it matches the name of the server, before downloading the file. The option is set to Yes by default, including for the profiles created before version 11.3.0.

• Yes
  The certificate is verified. An invalid, expired or self-signed certificate stops the import with an explicit error, and the file is not imported.
• No
  The certificate is not verified. Only use this setting for a server with a self-signed certificate that you trust, for example on your own network.

File Type

Allows you to specify the file type used for the update, XML, JSON, or CSV.

• File type
  You have the choice between CSV, XML, and JSON files.

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.
• Magento export file
  Magento default export files are made of empty rows with values related to main rows, activating this option will merge the values into the main rows.

For XML and JSON files, define: 

• Path to products
  Fill in the path that targets the products. The path is case-sensitive.
  See how to define the path to your products for XML or JSON files. 
• Data structure
  You have two options: Automatic detection or Predefined structure
  The automatic detection fits for simple files made of only one nesting level.
  If you've selected the Predefined structure, see how to define your own file structure for XML or JSON source file. 

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.
  

• Run indexers
  You can choose to run the indexers after the import or not:
  No: no indexer will run and you will have to reindex manually from the CLI
  Only the required indexers: automatically decides which indexers must run
  Only the selected indexers: let you decide which indexers to run
  
• Indexer to run
  Choose the indexers to run: 
  

  catalogrule_rule
  catalogrule_product
  catalog_product_price
  cataloginventory_stock
  inventory
  catalog_product_attribute
  catalog_url
  catalogsearch_fulltext
  catalog_category_product
  catalog_product_category

Advanced Settings

System Settings

In the System Settings, define the automatic action for missing products from the data file. You have several options:

• Do Nothing
• Disable the product
• Delete permanently the product
• Mark the product as out of stock
• Mark the product as out of stock and set qty to 0

When you decide to mark products that are missing from the data file as out of stock, you must select the targeted sources impacted by the action.

Great Lake Store

When a product is imported using Mass Product Import & Update, it is associated with the profile. If you've selected action for missing products, you'll need to choose the targeted products: 

• Only products related to current profile: products that are imported/updated with the same profile.
• Only products not related to current profile: all the products that are not created/updated by the profile.
• All products

Stock Settings

From the Stock Settings, you can define:

• Automatic stock status update
  You can choose to automatically update the stock status (in stock / out of stock).
• Use relative quantity update
  Quantity will be added/subtracted to/from the current quantity.
  

Image Settings

Indicates the path to the directory in which the images to import are stored.

• Images location
  Http server (URL)
  Magento File System
  Ftp server
  

Depending on what you've selected as the location of the images, you'll need to fill in several fields.

For the HTTP server:

• Download the image again if it has changed: Yes or No

For the FTP server:

• Use SFTP
  
• Use SSL
• Use active mode
• Host
• Port
• Login
• Password

For the FTP Server and the Magento file System:

• Path to images directory

Category Settings

Mass Product Import & Update allows you to create categories on the fly. 

• Create categories on the fly
  Yes or No.
• New categories active by default
  Yes or No.
• New categories included in menu by default
  Yes or No.
• Category tree auto-detection
  To automatically detect the category tree.
  You need to use the complete path to the category. The category levels must be separated with slashes: A/B/C.
  For example, instead of "Shirts", you should write:
  

  Default Category/Men/Shirts

• New categories are children of
  Choose the parent category.

Configurable Product Settings

Create parent of configurable products on the fly
You can also create/update a configurable product from the simple products available in the source file by enabling this option.

When that option is enabled, in the Mapping & Rules tab, you can find for each Target attribute dropdown an option for the configurable products to create on the fly. You have the choice to apply the settings on: 

• The current product only
• The configurable product created on the fly only
• Both, configurable product created on the fly and simple product associated

System attributes of the configurable products created on the fly must receive a value either by mapping a field from the source file for the simple product and the configurable product or for the configurable product only.

So that the configurable product and the simples variants are linked, the following attributes must be mapped:

• the SKU of the parent product or the SKU of the children products
• the configurable attributes

Mapping & Rules

In this section, you can map each column of the file with one of the stock attributes.

Column Mapping

Each column can be mapped with one of the stock attributes. Note that at any time, you can preview the input and output data in the black box directly.

• Target Attribute 
  Select the target attribute from the ones available in your system.
  You can find all the attributes grouped by type in our documentation.
  The first line is where you define the identifier of your products. The identifier must be unique, 
  

  SKU

• Data source
  In the Data source, you can define the attribute source that matches with the target attribute from your source file. 
  

  id

• Default value
  Sometimes, some columns can be missing. For example, when updating all stocks, the file does not necessarily include all stock attributes (backorders, minimum quantity in the cart...). In that case, you can choose custom value in the Data source and apply a default value. 
  

  yes

QUICK OVERVIEW OF THE INTERFACE

1. Add as many columns as you want by clicking on + ADD A NEW ROW. In many cases, the update file may contain more columns than necessary; you don't need to add these columns and match them.
2. DELETE a row easily.
3. Change the order of each row using the drag and drop.
4. Deactivate a line while conserving the settings by clicking on the LINK symbol.
5. Add your own custom script </>. These scripts can be previewed in the output. Note that when there is a script filled in, </>  is underlined. See how to use the PHP API. 
6. Add your own replacement rule by clicking on the  b icon. These rules can be previewed in the output. Note that when there is a rule selected, a b is underlined. See how to create your replacement rules. 
7. Apply the color of your choice to the row.
8. Apply a label to the row.
9. Define to which store view(s) you want to apply these settings by clicking APPLY TO DEFAULT VALUE.
10. Define to which product(s) you want to apply these settings by clicking APPLY TO THE CURRENT PRODUCT ONLY.
    For this setting to appear, the Create parent of configurable products on the fly option must be activated.
11. Define to which product(s) you want to apply these settings by clicking Apply to Both, new and existing products.
    For this setting to appear, the Profile method must be set on Update products and import new products.
12. Preview your file by clicking INPUT DATA.
13. Find all the attributes grouped by type in the LIBRARY.
14. Check the data as they'll be updated by clicking OUTPUT DATA.

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.

You have the possibility to change the cron task interval from the General Settings tab. 

Action History

In the Action History tab, you can find a history of your previous generation and configurations. 

You'll find: 

• ID
  It is the ID of the history line. 
  
• Version ID
  It is the ID of the profile configuration version.
  
• Origin
  The origin of the action can be: Backend / Cron / CLI / API
• Username
  It is the name of the user behind the action.
• Action
  The available actions are: create / generate / update / delete
  
• Details
  If you click on More details, you can see the detail of the profile update from a grid.
  

  

  If you click on a line of the above grid, you can check the differences of the updated field: red parts are the removed data and green parts are the inserted data.
  

  

  
  
• Date
  It is the date of the modification.

Export and import your profiles pattern

Mass Product Import & Update also allows you to import and export patterns into and from your Magento 2 admin.

Export

To export a profile, edit an existing feed from:
System › Data Transfer › Mass Product Import & Update

Edit a profile and click on Export.

You should find the profile pattern in your Downloads folder.

Import

Before anything, to import a profile pattern, it must be a .conf file, which is specific to the Mass Product Import & Update extension.

 Click on Import a Profile from:
System › Data Transfer › Mass Product Import & Update

Browse the .conf file and click on Import.

The profile pattern should have been added to the list.

Run your Mass Product Import & Update profiles

From the profiles grid

To run the profile from the grid, you just need to click on RUN PROFILE from the action menu on the right column. Then the status will be updated with a progress bar.

From the profile page

Edit the profile and then click on  RUN PROFILE NOW.

Once the import/update process has ended, a message appears with details about how many products have been updated/imported and how many products have been ignored.

With the cron tasks

When the scheduled tasks are configured for the profile, then the profile will be automatically run at the day and the time selected.

So that the scheduled tasks work well in Mass Product Import & Update, the main cron task in Magento must be configured properly. 

For more details about how to configure the cron tasks in Magento, look at the official Magento user guide: 
http://devdocs.magento.com/guides/v2.0/config-guide/cli/config-cli-subcommands-cron.html

You will receive an email each time the cron task is run if you have enabled the reporting in: 
Stores SETTINGS › onfiguration › Wyomind › Mass Product Import & Update

With the Command Lines Interface

Mass Product Import & Update includes command lines available from any shell console.

To run the profile:

bin/magento wyomind:massproductimport:run [-p|--profile_ids[="..."]]

For example, for profile 2, run:

bin/magento wyomind:massproductimport:run -p 2

To execute the SQL requests that generate when the profile is set to use the SQL mode:

bin/magento wyomind:massproductimport:sql [-p|--profile_ids[="..."]]

For example,, for profile 4, run:

bin/magento wyomind:massproductimport:sql --profile_ids=4

Use SQL option

Updating or importing products massively may keep your server busy some times, especially when the update or the import includes numerous products and/or many attributes.

For better performances Mass Product Import & Update splits the process into two distinct steps:

1. Source file analysis: the data are collected and the SQL queries for the update/import are built. 
2. The SQL file execution: the database is updated with the new data.
   This step may be executed asynchronously when the SQL option is enabled.

Generate the SQL file

If you prefer to generate the SQL file without executing it, you must enable the SQL mode in your profile configuration.

Then run the profile by clicking on  RUN NOW.

Execute the SQL file

Once the file is generated in the working directory, you only need to update the database with the generated file from the command line as follows: 

mysql -h host -p DbPassword -u DbLogin DatabaseName < path/to/mysql/file.sql

Advanced use

With Mass Product Import & Update, several events are triggered:

• massupdateimport_start
  Triggered when the update/import process starts. 
• massupdateimport_success
  Triggered when the profile is run and the data successfully updated/imported. 
• massupdateimport_failure
  Triggered when the profile is not run and the data are not updated/imported. 

The events can be used in your custom observers. 

The argument passed is an instance of Wyomind/MassProductImport/Model/Profile.

Below are some examples of use in an observer:  

• From etc/events.xml:
  

  <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../../../lib/internal/Magento/Framework/Event/etc/events.xsd">
  <!-- Standard checkout -->
  <event name="massupdateimport_success">
  <observer name="editor_module_massupdateimport_success" instance="EditorModuleObserverLassUpdateImportSuccess" />
  </event>
  </config>​

• From app/code/Editor/Module/Observer/MassUpdateImportSuccess.php:
  

  <?php
  namespace EditorModuleObserver;
  class LassUpdateImportSuccess implements MagentoFrameworkEventObserverInterface
  {
  public function execute(MagentoFrameworkEventObserver $observer){
  $profile= $observer->getEvent()->getProfile();
  // TODO: Implement your own logic.
  }
  }​

Attribute specifications to import or to update

Mass Product Import & Update allows you to import/update all attributes, even those with a custom model.

System attributes

The below attributes are required when importing new products.

If these attributes are not available in the mapping, then the imported products will be visible neither in the front-end or the back-end.

Sku

The unique identifier of the product to update or to import.

sku1

Attribute set

The attribute set to apply to the product.

You can either use the attribute set name (case insensitive) or the attribute set ID.

bag

15

To know the attribute sets available in your system, go to:
Stores › Attributes › attributE Sets

Type

The product type.

You must use the product type name (case insensitive).

It can be: 

• simple
• configurable
• grouped
• bundle
• virtual
• downloadable
• custom product type

simple

Website

The website(s) to which belongs the product separated by a comma. 

1

1,2

You can either use the website IDs or the website names (case insensitive).

Main Website Store

Main Website Store,Second Website Store

To know the names and the ids of the websites available in your system, go to:
Stores › Settings › All Stores

Tax Class

The product tax class. 

You can either use the tax class name (case insensitive) or the tax class ID of the product.

Taxable Goods

2

To know the names and  the ids of the tax classes available in your system, go to:
StoresSettingsConfigurationSalesTaxtax classes

Visibility

The product visibility. 

You can either use the visibility name (case insensitive) or the numerical value associated.

1. Not visible Individually
2. Catalog
3. Search
4. Catalog & Search

Catalog,Search

4

Status

The status of the product: enabled or disabled.

You can use any of the below values:

• enabled / disabled
• enable / disable
• true / false
• yes / no
• 1 / 0

enabled

Products attributes

All attributes created in your stores and/or any attributes that are listed in another section are available in the product attributes section.

Text or textarea attribute

The text or textarea attributes accept any value without any restriction.

Your text

Yes/no attribute

The yes/no attributes can be updated with any of the below values:

• enabled / disabled
• enable / disable
• true / false
• yes / no
• 1 / 0

true

Dropdown attributes

The drop-down attributes can be updated with:

• the option id
  

  4

• the option label
  

  red

The values of dropdown attributes can be translated to the different store view languages as below with the color attribute:

red[de=rot|fr=rouge|es=rojo]

For each store view language, you can choose to use the default value by using #empty#. Below, the DE translation will be empty and the default value red will be used (the default store is FR):

red[fr=rouge,de=#empty#]

If you want to use a fixed value, you can select one from the dropdown. 

Multi-select attributes

The multi-select attributes can be updated either with a list of option labels or a list of option ids separated with a comma.

Men, Boys

Note that all the multi-select options are now automatically populated and you can directly select multiple values:

To know the labels and ids of the drop-down and multi-select attributes, go to:
Stores › Attributes › Product › edit attribute › Manager label / option

Date attributes

The date attributes must be formatted with the date and time GMT:
YYYY-MM-DD hh:mm:ss

2019-06-11 15:09:52

Null value

EAV attributes can now be updated with null values.

For example, you can set a null value for the price attribute. To do so, NULL must be written in uppercase and without any space.

NULL

Prices attributes

Price

The price attribute can be a float number or an integer number.

It must be formatted with a dot as a decimal separator.

15.50

Special price

The special price attribute can be a float number or an integer number.

It must be formatted with a dot as a decimal separator.

10.50

Special price from/to date

The special price from/to date must be formatted with the date and the time GMT as below:
YYYY-MM-DD hh:mm:ss

2019-06-17 11:29:51

Tier price/Group price

You have two possibilities: 

• Add Tier price/Group price
  Creates a new Tier price/Group price that is added to the existing ones.
  
• Replace Tier price/Group price
  Replaces all the existing Tier prices/Group prices with the new ones.
  

The list of tier prices must be separated by ~ as below:
[Group id 1]|[Qty 1]|[Price 1]~[Group Id 2]|[Qty 2]|[Price 2]~...

*|5|9.99~*|10|7.99~...

To import your tier prices as discounts, add % at the end of each price. Otherwise, your tier prices will be imported in cash. 

*|5|10%~*|10|5%~...

Below is the list of the codes to use for the customer groups ids: 

• *: All groups
• 0: Not logged in
• 1: General
• 2: Wholesale
• 3: Retailer
• 4: VIP Member
• 5: Private Sales Member

Weee tax

The list of taxes must be separated by ~ as below:
country1|region1|tax1~country2|region2|tax2~...

• Country code
  It can be: FR, US, CA, NZ...
• Region
  Use * for all states
• Tax
  This is a fixed value

FR|*|13~UK|*|18

Stock attributes

All attributes related to the stock management in Magento are available in this section.

All these attributes must be updated with numeric values or boolean values.

Boolean values

Boolean values must be updated with one of the below values:

• 1 / 0
• yes / no
• true / false
• enable / disable
• enabled / disabled
• in stock / out of stock

in stock

Numeric values

Numeric values must be updated with one of the below types:

• Integer number (no white space)
• Float number (decimal separated by a dot)

10.50

MSI attributes

Mass Product Import & Update allows you to update all attributes related to the Magento Multi-Source Inventory Management (MSI).

All these attributes must be updated with numeric or Boolean values and mapped as follow. 

Quantity

The stock for the source.

9

Notify Qty

Notify the quantity for the source.

1

Use default for notify Qty

Use default to notify the quantity for the source.

true

Stock Status

Stock status for the source.

true

MSI Backorders attributes

Mass Product Import & Update also allows you to update all attributes coming with the MSI Backorders extension, also available in the MSI Suite.

You can retrieve these attributes in the products pages from:
Catalog › Products

Backorders

Choose the status of the backorder among:
 

• Allow Qty Below 0
• Allow Qty Below 0 and Notify Customer
• No Backorders

Allow Qty below 0

Backorders date

Backorders date in the following format:
YYYY-MM-DD hh:mm:ss

2020-03-25

Backordered qty

Backordered quantity.

50

Dynamic attributes

You have the possibility to create a dynamic mapping giving you more flexibility in the configuration of your profile. In your source file, for the same column, you can indicate the Magento attribute to map as well as the associated value.

Dynamic attribute

Code of the Magento attribute to map and the associated value.

The syntax to use is:
attribute_code=value

length=150

You can also use several dynamic attributes separated by a pipe in the same mapping row.

color=red|size=XL|description=description

Media attributes

All attributes related to the media management are available in this section.

The image/video source directory must be defined in the Image Settings tab.

Media Gallery

The images to insert in the image gallery must be listed in the Image Gallery field as the relative path to the image source directory specified in the Image Settings tab for local storage or FTP storage and as an absolute path if hosted on a remote server.

Each image path must be separated by one of the below characters:

• | (pipe)
• , (comma)
• ; (semi-colon)

Attention, we strongly advise you not to use the pipe separator if you use the parameters below because the image separator must be different from the parameter separator.

You can use the below parameters:

• media_type
  image (default value)
  external-video
• disabled
  Default value is 0.
  You have the possibility to assign values by storeview by suffixing disabled with the store code.
• label
  Default value is empty.
  You have the possibility to assign values by storeview by suffixing label with the store code.
• position
  Default value is 0.
  You have the possibility to assign values by storeview by suffixing position with the store code.
• destination
  Default value is empty.
  It is the name of the new image.

path/to/image_1.jpg[position=1|label=image 1]
path/to/image_2.jpg[position=2|label=image 2]
path/to/image_3.jpg[destination=new_image_3.jpg]
path/to/image_4.jpg[position=1|disabled=1|label=image 4]
path/to/image_5.jpg[disabled=0|label=red|disabled_de=1|label_de=rotte|disabled_fr=0|label_fr=rouge]

You can use additional parameters for external-video media type:

• provider
  Default value is empty.
• url
  Default value is empty.
• title
  Default value is empty.
• description
  Default value is empty.

path/to/video/preview.jpg[media_type=external-video|title=Video 1|url=https://vimeo.com/6370469]

In the case where you don't add the parameters in the syntax, the default values will be used. 

Base Image, Small Image, Thumbnail

You can associate a specific image from the Image gallery to any image attribute.

By default the image attribute available in Magento are:

• Base Image: image that appears on the product page
• Small Image: image that appears on the category page
• Thumbnail: image that appears on the cart, on the checkout, on the customer account...

If you have created your own image attributes in your stores, these attributes will be visible in this section.

Swatch attributes

Swatch

You can import/update Swatch attributes using their label for the default store: 

magenta

You can also use the below parameter:

• color
  You must add the hexadecimal code for the color in the below format:
  

  label[color=#HEXACODE]
  

  red[color=#FF0000]

  Note that when the color property is not imported, the existing color is kept for the swatch.

The values can also be translated to the different store view languages as below:
label[storecode="translated label"|color=#HEXACODE]

red[fr="rouge"|de="rotte"|es="rojo"|color="#FF0000"]

To remove the existing color for the swatch, you can import the color property using the empty value.

indigo[color=empty]

Category attributes

The categories associated with the products can be imported/updated with new values.

You have the possibility to choose the action between: 

• Replace all categories with
• Add to the categories
• Remove from the categories

Category mapping

List your category names (case sensitive) or category ids separated with a comma:
category ID 1 [position],category ID 2 [position]...

You can use the below parameter to define the position of the products in the categories:

• position
  Default value is empty.

For example, to import your product in position 2 in the category ID 10 and in position 1 in the category ID 13, you can write: 

10[2],13[1]

10[position=2],13[position=1]

The values will be translated into category paths according to the parameters you have defined in your profile configuration from:
Advanced Settings › Category Settings

In the case where you don't add the parameter in the syntax, the default value will be used. 

For example, to import products in the New Arrivals (ID: 10) and Dresses & Skirts (ID: 13) categories, from the Mapping & rules tab of your profile configuration, map the product attribute of your choice, for example, Add to the categories with a custom value.   

In the following field, you can define:

10,13

If you prefer using the category names, you could have written: 

Default Category/Women/New Arrivals,Default Category/Women/Dresses & Skirts

Categories will be created/updated according to what you've defined in the Advanced Settings tab

Merchandising attributes

The related/up-sell/cross-sell products can be imported/updated with new values. 

Related / Cross sell / Up sell products

List of related product SKU's separated by commas.

SKU1,SKU2,SKU3...

Configurable product attributes

With Mass Stock Import & Update you can create configurable products on the fly and create relationships between children and parents.

Parent SKU

Specify the parent SKU.

skuparent

When updating/creating a simple product, you can add the configurable product reference so that the simple products will be automatically associated with the configurable product. 

Children SKUs

List of the children SKUs separated by commas.

sku1,sku2,sku3

When updating/creating a configurable product, you can add the children references so that the simple products will be automatically associated to the configurable product.

Configurable attributes

Attribute code or attribute IDs separated by commas as below:
attribute code 1[position],attribute code 2[position]

You can use the below parameter to define the position of the configurable attributes:

• position
  Default value is empty.

size[1],color[2]...

In the case where you don't add the parameter in the syntax, the default value will be used. 

When creating/updating a configurable product, the configurable attributes must be specified.

Downloadable product attributes

With Mass Stock Import & Update you can import or update downloadable products.

Links title

Title of the downloadable resource.

Downloadable file

Samples title

Title of the downloadable resource.

Downloadable sample

Link URLs

Link to the file (relative or absolute path) and optional file's name separated by a pipe (|). 
Link | File name

http://www.example.com/filename.ext | My downloadable file

Sample URLs

Link to the file (relative or absolute path) and optional file's name separated by a pipe (|).  
Link | File name

http://www.example.com/filename.ext | My downloadable sample

Grouped product attributes

With Mass Stock Import & Update you can create grouped products and create relationships between children and parents.

Parent SKUs

When updating/creating a grouped product, you can add the parent references so that they will be automatically associated with the grouped product.

List of related parent product SKU's separated by commas

parentsku

Children SKUs

When updating/creating a grouped product, you can add the children references so that they will be automatically associated to the grouped product.

List of related children product SKU's separated by commas

You can use the below parameter:

• position
  Default value is empty.

sku1[position=2],sku2[position=1]

Bundle product options

With Mass Stock Import & Update you can add/update or remove options from bundle products.

Add/update an option

Bundle items option title as below:
Bundle items option title [type=select|required=1|option_position=1
|sku=SKU ABC|selection_qty=1|is_default=0|selection_price_type=0|selection_price_value=0
|selection_can_change_qty=0|position=1]
[sku=SKU XYZ|selection_qty=2|is_default=1|selection_can_change_qty=0|position=2]

You can use the below option parameters:

• type
  select / radio / checkbox / multi
  Default value is select.
• required
  Default value is 1.
  
• option_position
  Default value is 1.

And you can use the below product parameters:

• sku 
  SKU of the option's products
  It is a required value. 
• selection_qty
  Default value is 1.
  
• is_default
  Default value is 0.
  
• selection_price_type
  Default value is 0.
  
• selection_price_value
  Default value is 0.
  
• selection_can_change_qty
  Default value is 0.
  
• position
  Default value is 1.

Primary bag [type=select|required=1|option_position=1|sku=24-MB01|selection_qty=2|is_default=0|selection_can_change_qty=1|position=1][sku=24-MB05|selection_qty=1|is_default=1|selection_can_change_qty=0]

The above example will create the following option: 

In the case where you don't add the parameter in the syntax, the default value will be used. 

Remove an option

Bundle items option title to remove

Accessoiries

The above example will remove the "Accessoiries" option.

Custom options

With Mass Product Import & Update you can import or update your product custom options.

Dropdown / Radio / Checkbox / Select / Multi-select

Custom option title and option values in the following format: 
Custom option [title=title1|sku=sku1|price=10%|sort_order=1][title=title2|sku=sku2|price=10|sort_order=2]

You can use the below parameters:

• is_require
  If the custom option is a required field: is_require=1.
  Default value is: is_require=0
• title
  Default value is empty.
• sku
  Default value is empty.
• price
  Note that the price can be a percentage or a fixed amount. 
  

  10 or 10%

  Default value is null.
• sort_order
  Default value is null.
  

In the case where you don't add the above parameters in the syntax, the default values will be used. 

Engraving [is_require=1|title=Gold engraving|sku=engraving01|price=20%|sort_order=1][title=Silver engraving|sku=engraving02|price=10%|sort_order=2]...

Engraving [title=Gold engraving|sku=engraving01|price=50|sort_order=1][title=Silver engraving|sku=engraving02|price=30|sort_order=2]...

Text Field / Textarea

Custom option title and option values in the following format: 
Custom option Text [is_require=1|title=text|sku=txt|price=10|sort_order=1|max_characters=100]

You can use the below parameters:

• is_require
  If the custom option is a required field: is_require=1.
  Default value is: is_require=0
• title
  Default value is empty.
• sku
  Default value is empty.
• price
  Note that the price can be a percentage or a fixed amount. 
  

  10 or 10%

  Default value is null.
• sort_order
  Default value is null.
• max_characters
  Default value is null.

If no value is defined for the above parameters, the default values will be used. 

Custom option Text [is_require=1|sku=txt|price=10.00|sort_order=1|max_characters=100]

File

Custom option title and option values in the following format: 
Custom option Text [is_require=1|title=text|sku=txt|price=10|sort_order=1|file_extension=jpg]

You can use the below parameters:

• is_require
  If the custom option is a required field: is_require=1.
  Default value is: is_require=0
• title
  Default value is empty.
• sku
  Default value is empty.
• price
  Note that the price can be a percentage or a fixed amount. 
  

  10 or 10%

  Default value is null.
• sort_order
  Default value is null.

• file_extension
  Default value is null.

If no value is defined for the above parameters, the default values will be used. 

Custom option File [sku=upload|price=99.99|sort_order=2|file_extension=jpg,png,gif]

Replacement rules

Mass Product Import & Update allows you to control the data output by using replacement rules.

Create a replacement rule

You can create your own rule from:
System › Mass Product Import & Update › Replacement Rules

Click on Create a new Rule. 

Create a replacement rule manually

You can create your own rule manually.

Fill in a name and add the values you need to replace in the Input column with other values in the Output column. 

For example, the below example shows how to replace each "Summer 2018" with "Summer 2019" and all the rest with "This season". 

Note that you have the possibility to use regular expressions. 

Import a rule set from a CSV file

You also have the possibility to import a rule set directly from a CSV file. 

Click on Import a rule set from a CSV file and choose your CSV file. Click on Import. 

The CSV file must be composed of 2 columns, the first one for the values to replace and the second one for the replacement values.

These values must be separated by commas and enclosed by quotation marks.

"Winter 2016","Winter 2019"
"Winter 2017","Winter 2019"
"Winter 2018","Winter 2019"
"Summer 2016","Summer 2019"
"Summer 2017","Summer 2019"
"Summer 2018","Summer 2019"

Once the lines have been imported, you receive a notification. 

Use a replacement rule in your profile

Select a replacement rule

Once your rule is saved, you can use it in your profile from:
System › Mass Product Import & Update › Profiles

For the attribute you want to edit, click on the ab icon. 

A popup displays where you can select the rule you want to apply. Select the rule and click on Validate. 

Output the replacement rule value

If you click on Output Data from the black box, you should see the replacement rule value in purple followed by the original value in grey. 

PHP API for Mass Product Import & Update

Mass Product Import & Update allows you to fully customize and control the data output by using PHP scripts in different ways.

API coding standards

For each line in the Mapping & Rules tab of your profile, you can add your own custom script based on a PHP syntax.

To add your custom script, click on </> at the end of the line you want to edit. You can then update on the file the value of each column.

Opening and closing tags

Every script must include the opening PHP tag <?php. Note that it is not necessary to use the closing tag. 

<?php /* Your custom script */ return $self;​

Outputting a value

return
Any value that you want to output in your profile, must be returned with the return instruction.

$this object

$this->skip() or return false (boolean false)
To ignore the pending line (all the columns of the line).

$this->skipRow() or $this->skip() or return false;
To ignore the pending cell as well as all the following cells.

$this->skipCell() or return true;
To ignore the pending cell.

Variable $cell

You can call any column of the source file using $cell. It is an array that indexes each column numerically (1,2,3,...) and with a key corresponding to the name of the column header ("name","description","price"...).

$cell["name of the column"] or $cell[INDEX]

For example:

return $cell["description"]. " ".$cell["name"]

Variable $self

$self
To retrieve the current value of the column and manipulate the data:

<?php return $self;

For example:

<?php return strtolower($self);

Examples of use

Below are some examples of use with the PHP API. 

Change the separator

Transform a number with a floating value separated with a dot instead of a comma.

For example:

<?php return number_format(str_replace(",",".",$self),2,".",""); ?>

Change a text to lowercase or capital letters

Change a text in lowercase and add a capital letter as the first letter of each word.

For example:

<?php return ucwords(strtolower($self)); ?>

Retrieve images

Retrieve only one image from a list of images.

For example:

<?php return array_pop(explode(",",$self)); ?>

Group several columns

Put together several columns to create a description.

For example:

<?php return $self." ".$cell["product_name"].", starting at $".$cell["price"]; ?>

Define the visibility of a product

Define the visibility of a product depending on a column value.

For example:

<?php
switch($self){
case "parent":
return "Catalog, Search";
break;
default:
return "Not visible individually";
}
?>

Map value to other ones

Map values to other ones.

For example:

<?php
if($self=="something"){
return "something else";
}
else if($self=="foo"){
return "bar";
}
else{
return "default value";
}
?>

Retrieve values based on conditions

Output values based on different conditions.

For example:

<?php
if ($self > 200) return "0";
else return $self;
?>