Guide to Magento 2 Search Terms & Search Synonyms: Management, Import & Export Recomendations

- E-Commerce, Magento 2, Our extensions

Magento 2 Search Terms & Search Synonyms

Today, we are going to explore two tightly connected topics – Magento 2 search terms and Magento 2 search synonyms. The platform lets you optimize customer search queries by composing lists of search terms and search synonyms. While it is possible to manage them manually in your admin, you cannot import Magento search terms. And there is no way to import search synonyms to Magento 2 with the help of the platform’s built-in instruments. This limitation may negatively impact the productivity of backend administrators since they need to spend a considerable amount of time updating Magento 2 search terms and synonyms instead of transferring the necessary data within a few clicks.

However, there is a tool that unlocks the missing functionality. Meet the Improved Import & Export extension. This module empowers you to import and export search terms and search synonyms to Magento 2. Below, we explain how to use the tool to transfer the corresponding entities to and from your e-commerce website. You will learn how import and export processes work and what attributes are involved in the import and export of search terms and search synonyms. But before going any further, let’s see what Magento 2 search terms and search synonyms are. 

Table of contents

Magento 2 Search Terms & Search Synonyms Defined

Let’s briefly explain the difference between the two terms:

Magento 2 Search Terms – Customer’s Path to Desired Products

In Magento, search terms allow a store administrator to redirect customers to a particular store page if a certain search query is entered in the search field.

Since search terms are configured by admins, customers need to type the keywords of the products they are looking for to get them on the search results. As a store administrator, you can use Magento 2 search terms to conduct surveys of customer demands by tracking what customers are looking for.

Magento 2 Search Synonyms – Bridge Between Different Inquiries

Magento 2 search synonyms, on the other hand, allow a store administrator to compose a list of queries that bear the same search results. They simply connect different words so that they provide the same results. For example, you can use search synonyms to combine the words “laptop,” “notebook,” and “netbook” to introduce users to all the laptop-type products despite the word they have chosen for the search.

Now, that you know the difference between search terms and search synonyms of Magento 2, let’s see how to manage them in your Magento 2 admin.

Finding & Managing Search Terms & Search Synonyms in Magento 2

Navigate to your Magento 2 administrator panel and proceed to Marketing > SEO & Search. In this menu section, you can find Search Terms and Search Synonyms.

Both sections represent a grid with terms and synonym rules. The grids share a native Magento 2 grid look and functionality and come with filters and mass actions, – nothing special.

Magento 2 Search Synonyms

The differences come when you are creating terms and synonym lists.

Magento 2 Search Terms Settings

The search terms define the behavior of Magento 2 search when the customer enters a particular search query. You can create multiple search terms under Marketing -> SEO & Search -> Search Terms. Just hit the Add New Search Term button and fill in these fields:

Add Magento 2 Search Terms

  • Search query – defines a word or a phrase a customer should enter in the search field to get redirected to a particular page.
  • Store – defines store views the search term rule is applied to.
  • Redirect URL – defines the URL the customer should be redirected to.
  • Display in Suggested Terms – defines whether the term should be displayed in the Suggested Terms at the Magento 2 storefront.

According to the configuration in the screenshot above, if a customer enters the Firebear Studio search inquiry, they will be redirected to the product page of the Improved Import & Export extension. It works only on the default store view. Firebear is displayed in the suggested terms.

How Magento 2 Search Terms work

As for the aforementioned surveys, the corresponding data is available right under Marketing -> SEO & Search -> Search Terms in the grid with search terms. You only need to pay attention to the Results and Users columns.

Magento 2 Search Terms stats

Magento 2 Search Synonyms Settings

In Magento 2, search synonyms are available under Marketing -> SEO & Search -> Search Terms. They allow you to specify a list of words that should bear the same meaning in terms of providing search results for the customers.

Magento 2 Search Synonyms grid

Just hit the New Synonym Group button and configure these settings:

add Magento 2 Search Synonyms

  • Scope – defines the websites to which this particular list of synonyms should be applied.
  • Synonyms – a text field where you specify the words that should bear the same meaning in terms of search. Separate these words by a comma without spaces.
  • Merge existing synonyms – this feature automatically merges synonyms in groups that share the same scope. If you check this box and add one or more of the same terms to different synonym groups in the same scope, it will automatically merge all the terms into one group.

Please, note that Magento 2 search synonyms don’t impact the search term behavior. If you have the search term Firebear Studio and the synonyms firebear studio, firebear, fire bear, and fire-bear, only the tern firebear studio will redirect customers to the Improved Import page.

Magento 2 Search Terms and Search Synonyms are not connected

Importing & Exporting Search Terms & Search Synonyms in Magento 2

Native Magento 2 import and export tool doesn’t let you handle search terms and search synonyms. You need the Improved Import & Export extension to import and export search terms and search synonyms to Magento 2. Let’s say a few words about the module and then proceed to the import and export procedures. 

Еру Improved Import & Export Magento 2 extension is a full-featured data management tool fully operational from the Magento 2 administrator panel. It’s features include:

  • Support for all Magento 2 entities, including B2B and MSI.
  • Support for all Magento 2 product types: simple, configurable, bundle, grouped, downloadable, virtual.
  • Support for multiple import sources including Google Sheets, FTP/SFTP, and Dropbox.
  • Support for REST and SOAP APIs for connection with any system or service.
  • Support for CSV, XML, Excel XLSX, ODS, and Json files.
  • Custom import logic with support of XSLT translation templates.
  • Powerful attribute and separator mapping.
  • Open code and customization endpoints for better integration.
  • One-time payment. No SAAS, no recurring payments, no subscriptions

Visit the extension product page for more information:

Get Improved Import & Export Magento 2 Extension

How to Import & Export Magento 2 Search Terms & Search Synonyms

With the Improved Import and Export extension for Magento 2, you will be using jobs to import and export search terms and search synonyms in Magento 2. A job is a set of rules that define which entity and on what conditions should be imported/exported to Magento 2.

To find the extension’s jobs proceed to System > Improved Import/Export > Import Jobs. Here you will be presented with the import jobs grid, from which you can create new import jobs and manage existing ones.

import and export Magento 2 Search Terms & Search Synonyms

To import or export search terms or search synonyms in Magento 2, create a new job by clicking the ‘Add New Job’ button. In the general job settings specify the name of the job and schedule if you want to automate the transfer of search terms or search synonyms.

Magento 2 Search Terms & Search Synonyms: import settings

In the Import Settings, select the entity you want to import or export. In our case, we are interested in Search Terms and Search Synonyms. When the entity and selected and the behavior specified you can proceed to selecting the import source and the file type you will be using.

Magento 2 Search Terms & Search Synonyms import source

In the Import Source section, you can select the type of file you will be importing. Improved Import & Export supports CSV, XML, Json, XLSX, and ODS file formats. Also, specify the source of the file: direct URL, Dropbox, FTP/SFTP, or Google Sheets (you only need to share, and paste the link).

Once you have specified the file location hit the ‘Validate file’ button. Improved Import & Export extension will run the necessary checks and you will be able to hit the ‘Save & Run’ button to execute the entity import.

If you want to export search terms or search synonyms from Magento 2, you won’t be asked to validate the output. Just run the export process.

For more information on how to use the Improved Import and Export extension read the extension manual.

Now, let’s say a few more words about attributes used to describe search terms and search synonyms in Magento 2.

What Attributes to Use to Import Search Synonyms & Search Terms to Magento 2

Sample files containing all search term and synonym attributes can be found at:

  • Google Sheet Master table – a table where we have gathered all Magento 2 entities and explained every entity attribute.
  • Firebear GitHub – here you can find files of different file types containing sample values for every Magento 2 entity.

Let’s focus on Magento 2 attributes for search terms and search synonyms individually.

Magento 2 Search Terms Attributes

Like every Magento 2 entity, search terms and synonyms are composed of a set of attributes. In the table below you can find the description of every attribute and sample values you can use for editing.

Below, you can see an example of a Magento 2 Search Terms CSV:

Magento 2 Search Terms CSV table

Now, let’s describe each attribute available in the grid.

Attribute Name Reference Values Value Example
query_id ID of the search query term. It can be found at the URL of the edit term page under the administrator panel For example in the url of the page:

/index.php/admin/search/term/edit/id/2/

The ID of the search term is ‘2’.

Can only contain numerals.

132
query_text Search Query – the word or phrase that you enter in the search query field Can be any value import
num_results Number of results field of the search term Can only contain numerals 0
popularity Number of Uses field of the search term Can only contain numerals 1
redirect A redirect URL field of the search term. Defines the page where customer should be redirected Must contain a full URL of the page. Including https:// https://firebearstudio.com/
store_id The ID of the store where the search term is available Can only contain numerals. The store ID can be found in the Stores > All Stores section of the administrator panel 1
display_in_terms Display in the Suggested Terms setting of the search term 1 – Yes

0 – No

1
is_active Defines if the search term is active or disabled 1 – Active

0 – Disabled

1
updated_at The date the search term has been last updated on Can only contain date and time format, for example:

2019-02-13 6:19:21

2019-02-13 6:19:21

Magento 2 Search Synonyms Attributes

Follow these links to find a sample CSV with Magento 2 search synonyms:

Below, you can see an example of a Magento 2 Search Synonyms CSV:

Magento 2 Search Synonyms CSV table

It is smaller than the one associated with search terms of Magento 2. Now, let’s describe each attribute available in the grid.

Attribute Name Reference Values Value Example
group_id The ID of the search synonyms group. It can be found at the URL of the edit synonym group page under the administrator panel. For example in the url of the page:

/index.php/admin/search/synonyms/edit/group_id/1/

The ID of the synonyms group is ‘1’.

Can only contain numerals.

1
synonyms Synonyms field where you specify the words separated by a comma which bear the same meaning in terms of the search Do not put spaces after the commas.

Can contain any symbol.

firebear,studio,fire,bear,studio
store_id The ID of the store the synonym group should be applied to Can only contain numerals. The store ID can be found in the Stores > All Stores section of the administrator panel 0
website_id The ID of the website the synonym group should be applied to Can only contain numerals. The website ID can be found in the Stores > All Stores section of the administrator panel 0

IMPORTANT: make sure NOT to use THE SAME word for different synonym groups to avoid errors.

That’s it. Having all the information above you can start importing and exporting Magento 2 search terms and synonyms.

Get Improved Import and Export extension for Magento 2

Magento 2 Search Terms & Synonyms Import & Export FAQ

Let’s take a look at other nuances of importing and exporting search terms and synonyms in Magento 2 with the help of the Improved Import & Export Magento 2 extension.

How to import and export Magento 2 search terms and synonyms automatically?

If you need to move search terms and synonyms between Magento 2 and third parties or other Magento 2 websites regularly, you can use the Improved Import & Export extension. It utilizes a cron scheduler to automate data transfers. Thus, you can import and export search terms and synonyms between Magento 2 and external destinations automatically, according to a schedule of updates. Next, the module does everything for you.

How to import search terms and search synonyms to Magento 2 with third-party attributes?

Magento 2 blocks the import of third-party data that doesn’t follow its requirements. However, you can enable the missing opportunity to work with external attributes with the help of the Improved Import & Export extension. The module lets you create a mapping scheme where you match third-party attributes and values to ones used within the system. As a result, any external data, including search terms and synonyms, is easily adapted to the native standards of your e-commerce website. Note that you can also apply mapping to export processes to generate the output your partners require.

How to import and export Magento search terms and synonyms via API?

The Improved Import & Export Magento 2 extension provides the ability to create API connections for transferring search terms and synonyms along with other entities. There is a dedicated section module’s import/export jobs where you specify the parameters necessary to sync the two systems. Note that you can create a bi-directional API connection for transferring search terms and synonyms. As for unsupported attributes, the plugin lets you leverage its mapping functionality to transfer them via API connections.

How to import and export Magento 2 search synonyms and terms via ODS files?

Improved Import & Export lets you move search terms and synonyms via ODS files. You no longer need to convert them to CSV to fit the Magento 2 requirements. You can also export data using this file format.

How to import and export search terms and synonyms to Magento 2 via XLSX files?

In addition to ODS, Improved Import & Export lets you move search terms and synonyms via XLSX files. You no longer need to convert them to CSV to fit the Magento 2 requirements. You can also export data using this file format.

How to import and export Magento 2 search terms and synonyms via JSON files?

Also, Improved Import & Export lets you move search terms and synonyms via XLSX files. You no longer need to convert them to CSV to fit the Magento 2 requirements. You can also export data using this file format.

How to import Magento 2 search synonyms and search terms via compressed files?

If your files with search terms and synonyms are compressed, you can transfer them to Magento 2 with the help of the Improved Import & Export extension. Remember that your file archive should be in a ZIP or TAR format. Our module supports compressed CSV, XML, ODS, JSON, and XLSX files.

How to import Magento 2 search synonyms and Magento 2 search terms from Google Sheets?

If search terms and synonyms are stored in Google Sheets, it is no longer a problem. You don’t even need to move data files. The Improved Import & Export extension eliminates the necessity to export them from the service, convert them to CSV, and then transfer the output to Magento 2. The module lets you move the corresponding information straight from Google Sheets to your e-commerce website. It is only necessary to specify the address of the corresponding data table.

How to import and export search terms and synonyms to Magento 2 from Dropbox?

The Improved Import & Export module lets you transfer search terms and synonyms to Magento 2 from Dropbox. You can store them there in CSV, JSON, XML, ODS, or XLSX files or ZIP and TAR archives. You can also use this file storage as your export destination.

How to import and export search terms and synonyms to Magento 2 from Google Drive?

In addition to Google Sheets and Dropbox, the Improved Import & Export extension provides the ability to import and export search terms and synonyms between Magento 2 and Google Drive. You can store them there in CSV, JSON, XML, ODS, or XLSX files or ZIP and TAR archives.

Final Words

Magento 2 search terms and Magento 2 search synonyms are inevitable parts of a customer journey. You can use these instruments to simplify the lives of your buyers, direct them to parts of your website where you want them to be, help them navigate to desired products, and learn their search habits. Luckily, it won’t take much time to compose search terms and search synonyms for Magento 2. You can either do everything manually or import the corresponding data with the help of the Improved Import & Export extension. Follow this link for more information:

Get Improved Import and Export extension for Magento 2