User Tools

Site Tools


Sidebar

magento_2:import_orders

For more details see how the Import Orders for Magento 2 extension works.

Guide for Import Orders for Magento 2

Transfer orders placed on third-party sources, marketplaces and other online stores into your Magento 2 store. Use Import Orders extension for Magento 2 to build a single management system across all platforms.

  • Import order data from the third-party platforms, marketplaces, Magento and non-Magento online stores
  • Avoid database errors and data losses with file validation
  • Create unique import profiles suitable for specific platforms
  • Execute import profiles manually or by cron
  • Import huge volumes of orders (up to 500.000)
  • Complete various business tasks with the 2 extra Amasty Import interfaces
Download the sample data in CSV, XML, ODS and XLSX formats: sampledata.zip

The Import Structure

Amasty Import by now has 3 separate modules to carry out import tasks:

  • Import Orders: a separate import interface to deal with order entities
  • Amasty One-time Import: suitable for a one-time import of any available entity
  • Amasty Import Cron Jobs: a tab to create cron jobs concerning import activity

The more Amasty modules you have, the more entities you will be able to import in the simplified module and in the Cron Jobs version. Follow Import & Export solution updates to discover new possibilities.

Import Orders Configuration

Before building import profiles, configure the basic import performance options.

Go to Stores → Configuration → Amasty Extensions → Import Orders.

General Settings

Import Batch Size - set number of orders that will be processed in an iteration.

Import History Auto-Cleaning - choose Yes to clean logs automatically. The records will be removed from Import History after the period specified below.

Auto-Cleaning Period (Days) - define the period after which import history will be cleaned.

Multi-Process Import

Enable Multi-Process Import - enable this option to perform import in multiple threads and speed up the import process.

The 'Multi-Process Import' feature requires the PHP extension 'pcntl' to be installed on the server. If you enable the feature and no performance boost happens, please ask your hoster/system administrator to check if the 'pcntl' extension is installed.

Number of Parallel Processes - if the previous option is enabled, specify the number of processes according to your server capabilities. The more parallel processes are set, the faster the import process goes, but the higher the load on the server is.

Keep in mind, that the multi-process for Amasty One-time Import and Amasty Import Cron Jobs should be enabled in the other tab.

Import Orders Profiles

The extended order import functionality allows you to create flexible profiles for import and execute it on regular basis. To view all the profiles, proceed to System → Import Orders → Profiles.

Here you can see all existing profiles, their IDs, names, file formats, execution types and the dates of the last run/update.

New Profile Creation

Let's consider the case of new profile creation. For example, we want to set automatic import of orders from Amazon.

First of all, hit the Add New Profile button.

General Configuration

Profile Name - specify the name of the profile for internal usage. This name will be displayed in the grid.

Batch Size - set the number of orders that will be processed in an iteration. You may configure batch size for each profile separately or specify the value in general configuration and use this default value.

You can duplicate the already created profiles if you want to build a profile similar to the existing one.

Actions With Orders After Importing

You can also automatically execute particular actions when the orders are imported.

Change Processed Orders Status To - specify the status that imported orders will get.

Change Only New Orders Status - if enabled, the action will only apply to new orders that were created during the import process and not affect the orders that were just updated.

Actions that can be applied to order documentation:

  • Invoice Order After Importing
  • Ship Order After Importing
  • Create Credit Memo After Importing
  • Cancel Order After Importing

All these actions can also be applied to newly-created orders only. Additionally, you can send automatic notifications to customers.

File Settings

Now we need to choose the required file type and configure its settings.

The following formats are available:

  • CSV
  • XML
  • ODS
  • XLSX

For CSV, ODS and XLSX formats you can:

Rows Merged into One - enable this option if the rows in the import files are merged.

For a CSV file you can additionally set:

  • Merged Rows Data Delimiter
  • Field Delimiter
  • Field Enclosure Character

For a XML file specify the path to the node in the Data XPath field, e.g. if you have <items><item>1</item><item>2</item></items>, the path will be items/item.

We've chosen a CSV format.

You can download sample files for the appropriate file formation.

Import Source

Now choose a suitable import source.

Available sources:

  • Local Directory
  • File Upload
  • FTP
  • SFTP
  • URL
  • Google Sheets
  • REST API Endpoint
  • Dropbox
  • Google Drive

For Local Directory specify a File Path relative to Magento installation (e.g. var/import/import.csv).

For File Upload select the file to import. Make sure your file isn't more than 2M and it is saved in UTF-8 encoding for proper import.

If you want to use FTP / SFTP for import, you will need to fill the following fields:

  • Host
  • User
  • Password
  • File Path
  • File Name for FTP/SFTP.

For FTP you can also enable a Passive Mode.

For URL source, apart from the URL itself, provide Basic Authentication Username and Password.

The document should be opened by a direct URL, and the URL should contain the file format, e.g. https://example/download?id=19&file=-1.xml (here we use XML format). It is necessary since in Google Cloud the link to the file is used without an extension, and the Import Orders extension can't validate it. Thus, you need to add the format. Additionally, if the access is shared for all users, then the username and password fields are not required. If only certain users can see the file, then you need to enter their credentials for access.

For Google Sheets specify the required URL.

When using Google Sheets (you can import a file of different formats there), you need to specify the required format and specify the same format when importing. The link to the doc should be shared with everyone.

For REST API Endpoint provide the endpoint (e.g. https://magento.instance/rest/all/V1/some/endpoint) and choose the required authentication method.

Dropbox Configuration

To import using Dropbox, you will need to provide the access token. Follow the steps below to get the token.

1. Go to https://www.dropbox.com/developers and sign in.

2. Hit the Create Apps button.

3. Choose an API, a type of access you need and specify the title for your folder.

Agree with the terms & conditions and click Create App. You will be automatically redirected to the folder configuration.

4. Proceed to the Permissions tab.

Grant the permissions to write the files and click Submit.

5. Return to the Settings tab.

6. Find the OAuth 2 section and hit the Generate button below the Generated access token field.

7. Copy the token and paste it into the Generated Access Token field.

Google Drive Configuration

To set the integration with Google Drive, you need a specific API key. To get the key and configure this import source correctly, follow the steps below.

1. First of all, you need to install Google APIs Client Library on your Magento instance. Click here and install composer require google/apiclient:“^2.0”.

2. Go here and choose a project or create a new one if necessary.

3. When the required project is chosen, return to this page and enable Google Drive API.

4. If everything is correct, you will see the following status:

5. Click Manage and proceed to APIs & Services → Credentials. There click Create Credentials →Service account.

6. Provide Service account details. You can skip Step 2 and Step 3.

Click Done.

7. Navigate to the Service accounts tab and find the required service. Expand the Actions dropdown and hit the Manage keys option.

8. Expand the Add Key dropdown and select Create new key.

9. Choose JSON file format and hit the Create button.

The file will be automatically generated and downloaded.

10. Proceed to the Details tab and copy the email.

11. Go to My Drive. Create a folder from which the files will be imported to Magento. Specify the title.

12. Now click Share and insert the email that you've copied. Click Done.

13. Return to the admin panel. Upload a JSON file, provide the path to the created folder and file title.

The configuration is ready. Run import profile and check the result.


As we already have a CSV file to import, we've chosen the File Upload option.

Import Settings

In this tab, you can adjust import behavior.

Import Behavior - choose a suitable behavior for import:

  • Add/Update - in this case, the extension compares order IDs from the import file and the already existing orders in the Magento instance. If an order ID is unique and doesn't exist in Magento, a new order will be created. If an order with the same ID exists, the extension just changes/adds the data specified in the import file.
  • Only Add - the extension imports orders with new IDs and skips the already existing ones.
  • Only Update - the extension updates the information in the existing orders and skips not existing ones.
  • Delete - the extension deletes the orders specified in the import file from Magento.

Enable Autofill for Typical Use Cases - if enabled, Fields Configuration will be automatically filled in with the settings to perform the typical use cases for importing orders from third-party systems. The setting can be used only during new profile creation.

Each behavior has a specific pull of the required fields, e.g. if you add new orders, your import file must contain more columns than in the update behavior.

The required data for add behavior: Order, Order Item, Payment, Shipping Address, Billing Address.

Please, enable the autofill option to avoid errors during import and map fields properly.

Order Identifier - choose Order Entity ID or Order Increment ID as an identifier.

Order Entity ID is the ordinal number in the database provided by Magento. Order Increment ID is used for Order purpose and order fetching/display information of a specific order based on the increment id.

Validation Strategy - you can either stop the import process if any error appears (Stop On Error option) or skip invalid data and continue importing (Skip Error Entities option).

Please, note that if you Skip Error Entities and some configuration issues exist, the extension will complete the import with a 'Success' status, but 0 orders will be imported.

If you choose Stop on Errors option, the status will be 'Failed'.

Allowed Errors Count - specify the number of errors to halt the import process.

Customer Mode - select the strategy to deal with customers:

  • Guest Order If Customer Doesn’t Exist - if a customer is not registered in the Magento store, the orders will be imported as if a guest customer has placed them. If the extension finds the specified customer in Magento, the order will be assigned to this customer.
  • All Orders as Guest Orders - in this case, all imported orders will be placed as if guest customers have placed them.
  • Create Customer If Customer Doesn’t Exist - if a customer is not registered, the extension will create this customer using the data from the import file and assign the order to the newly-created customer.

As we want to import orders from Amazon for the first time, we've selected the Only Add import behavior and a Guest Order If Customer Doesn’t Exist strategy.

Fields Configuration

In this tab, you need to choose the required entities and map fields. If you enabled the Autofill for Typical Use Cases option previously, the required fields will be automatically added and you can proceed to mapping. If the option was not enabled, you need to add the entities and fields manually.

Please, attentively check all the fields before importing. Otherwise, the extension won't be able to match the columns and will display an error.

The functionality has a tree structure. Thus, you can add any entity, any field within a particular entity, customize entity keys/field names/delimiters and so on to match the requirements of the import.

See how the tree-structure configuration is created:

Below you can see all available for importing entities:

Apart from adding required entities and fields, you need to map all required fields and additional fields that you want to import from the file.

Let's see how to configure the mapping.

First of all, open your import file and check how it is configured. Pay attention to column names and delimiters.

As we see, in our file all columns have a custom entity key - amazon.

In this case, we need to provide the same entity key in the fields configuration.

Then we check the delimiters. In our file we have a slash as the delimiter:

Thus, we need to specify the same delimiter in the configuration:

If ready, proceed to column names.

In the configuration, we see that the entity_id, state and status are the required fields (as they were autofilled).

Now we check if we have the same columns in our import file.

Here we see that the columns are present, but they have a different column name, e.g. instead of entity_id we have just entity. In this case, we should match the title from the import file with the title in Magento.

If the titles are identical (as we have for the state column), just leave the Import File Field empty.

If you check all fields and see that some of the required ones are absent in the import file, set the Default Value. For example, Magento requires store_id column, but we don't have this one in our file as Amazon doesn't have this parameter. In this case, we can just provide the required ID in the Default Value field (e.g. 1).

This way, you need to check all fields and map the titles so that the extension could import orders properly. Add any entities and provide custom entity keys if needed.

To add the fields, click Map Fields and choose the necessary ones in the modal window. Use the search field to speed up configuration.

When the configuration is ready, upload the file in the Import Source tab. Click Save and Continue Edit.

Now you can Validate the file.

The extension will display validation progress and results in a popup window.

If the configuration was incorrect, you will see an error.

In case of successful validation, you can start the import.

Modify Values Before Import

Now you can use modifiers to change the values specified in a file before importing. For example, you can change the date format, add any text and apply various mathematical actions to prices (e.g. rounding, multiplication, etc.).

Modifiers are added right during the fields configuration.

Hit the Add Modifier button and choose the required action in a dropdown.

Types of modifiers you can use:

  • Text Modifiers: Adjust the text of the text values by appending, prepending, capitalizing, etc.
  • Numeric Modifiers: Use for number modifications, e.g. rounding prices.
  • Date Modifiers: Specify a suitable date format.
  • Custom Modifiers: Replace the output of one field with the value of another.

Text Modifiers

Append - Adds the text after the value in the column. The text is specified in an additional field that appears when this modifier is selected.

Prepend - Adds text before the value in the column. The text is specified in an additional field that appears when this modifier is selected.

Trim - This modifier removes spaces from the beginning and the end of the string (there is already a trim).

Upper Case - After selecting this modifier, the entire word in a value field is capitalized.

Lower Case - After selecting this modifier, the whole word is written in lowercase.

Capitalize - After selecting this modifier, the value in the column is capitalized.

Capitalize Each Word - After selecting this modifier, each word starts with a capital letter.

Strip Html Tags - Modifier removes all HTML tags from the string (the modifier is useful when importing meta titles, descriptions, etc.).

Replace - After choosing this modifier, 2 fields appear: in the first one we indicate the word that needs to be replaced, and in the second one - the word to be replaced with.

Replace First - the same as Replace, but for the first case only.

Numeric Modifiers

Absolute Value - Modifier changes the negative value in the column to positive. Example: was -5 → now is 5.

Round To - When this modifier is selected, an additional field appears, in which we indicate the number of decimal places to which we round the number in the column. Example: 33.75 → enter 1 → get 33.8.

Plus - When this modifier is selected, indicate the number that is added to the number in the column.

Minus - Indicate the number that is subtracted from the number in the column.

Multiplied By - Specify the number that is multiplied by the number in the column.

Divided By - Provide the number by which the number in the column is divided.

Modulo - Indicate the number by which the number in the column is divided, and when division occurs, we get the remainder of the division in the export file. Example: we have 10, entered the number 3, received 1 in the file.

Truncate - Modifier removes decimal numbers without rounding. For example: 33.75 → Truncate → 33.

Ceil - Modifier allows you to round a number up to the nearest whole number.

Floor - Modifier allows you to round a number down to the nearest whole number.

Date Modifiers

Date Format - Specify the date format that is applied to the date in the file.

Custom Modifiers

Сustom modifiers replace the output of the value of one field with the value of another. For example, Option Label to Option Value: instead of label, the value will be imported. Or, for instance, Status Code for Status ID: instead of code, the id will be imported.

Automatic Import

If you have configured the mapping and the orders were imported successfully, you can set the automatic import of future orders.

Run Profile by Cron - if enabled, the import will be initiated automatically by cron according to the schedule specified.

Frequency - choose a suitable import schedule.

If you choose a custom one, provide the schedule manually.

Alert Notifications

Using this tab, you can enable email notifications about errors for a particular profile.

Enable Email Alert - set to Yes to notify the recipients about failed imports.

Email Sender - choose the contact that will send automatic emails.

Email Recipients - set to whom the emails will be sent.

Email Template - select the template for failure notifications.

Profile Import History

For each profile a separate import history is available. Check the statuses, dates and logs.

General Import History

You may also check the logs for all import profiles in one place. Navigate to System → Import Orders → History. See the statues and check details to get a full picture.

Amasty One-time Import: Fast & Easy

This extension is helpful to perform one-time operations as it has a simplified UI. If you have only the Import Orders extension, you will be able to import any order entity, but if you will have other import extensions by Amasty, you will easily import any available entity in one place.

Go to System → Amasty Import → Import and select the entity to import.

As soon as you choose the entity, you will be able to configure import details, such as format, title, included fields, etc. Check each configuration detail for each tab in the Import Profile Configuration sections.

General Settings for One-time Import

To configure the basic options for Amasty Import, navigate to Stores → Configuration → Amasty Extensions → Import.

Enable Multi-Process Import - set to Yes to speed up the import.

The 'Multi-Process Import' feature requires the PHP extension 'pcntl' to be installed on the server. If you enable the feature and no performance boost happens, please ask your hoster/system administrator to check if the 'pcntl' extension is installed.

Number of Parallel Processes - specify the number of processes according to your server capabilities. The more parallel processes are set, the faster the import process goes, but the higher the server loads.

Amasty Import Cron Jobs

Also, the extension includes Amasty Import Cron Jobs features: you can create regular cron jobs to import any available entity.

Go to System → Amasty Import → Cron Jobs.

The more installed Amasty Import extensions you have, the more entities you can import by cron.

Click New Import Job.

Specify the cron job title for internal use and set the schedule for importing. The file configuration algorithm is the same as described in the Import Profile section.

Compatibilities

The extension is fully compatible with Amasty Gift Card. Thus, you can import any gift card info you need.


Find out how to install the Import Orders extension for Magento 2 via Composer.
Rate the user guide
 stars  from 2 votes (Details)
magento_2/import_orders.txt · Last modified: 2021/09/23 07:01 by tihomirova