Skip to main content
  2. Markets and price search engines
  3. idealo
  4. Setting up idealo

Setting up idealo

On this page, you will find information about the settings you need to carry out in order to set up the market and price comparison portal idealo Checkout in plentymarkets. Learn how to set up the interface, how to export items to idealo Checkout and how to define sales prices.

1. About idealo

idealo started business in 2000 with the vision of helping users to make the right choices when buying products online and, now counting 50,000 sellers and 18 million users per month, has become one of Germany’s most important e-commerce websites.

With idealo Checkout, idealo offers a strong sales channel. The "Zum Kauf" (Buy now) button allows users to order a product directly on idealo.de, using a fully integrated checkout function. The sellers remain the contractual partners and take care of fulfilment as usual.

With plentymarkets, you can both use the idealo price comparison and idealo Checkout. idealo Checkout enables your customers to buy items directly on the idealo website without having to enter your plentyShop.

2. Registering with idealo

In order to set up idealo in your plentymarkets system, you have to register as an idealo seller first.

3. Select a method for item data export

Inform idealo about how item data should be transferred before setting up idealo in plentymarkets (creating, updating, and deleting items on idealo). You can either transfer item data to idealo with the automatic item export via an API (PWS 2.0 interface) or with a CSV file using the elastic export. Table 1 shows the most important differences between these two methods of exporting item data. How to set up the different methods of data transfer in plentymarkets is described in the chapter Setting up the item export.

Contact idealo if you transfer your items via API

If you would like to export your items to idealo via API (PWS 2.0 interface), first contact idealo at tam@idealo.de.
Table 1. idealo data transfer
Item data export via API (PWS 2.0) Item data export via elastic export

Item data export via interface

Item data export via CSV file

Unlimited number of items can be transferred

To transfer more than 9999 items to idealo, the option Generate cache file must be activated in the Elastic Export settings. If the option Generate cache file is activated, the output file will only be generated every 24 hours. This is to save resources.
Note: We recommend that you do not activate the option Generate cache file for more than 20 export formats. This is to ensure a high performance of the elastic export.

Items are created once a day

Retrieval of item data via URL that is saved at idealo

Price updates every 15 minutes

Time interval for retrieval of item data is defined by idealo

Stock updates every 15 minutes

Time interval for retrieval of item data is defined by idealo

Orders are imported to the selected client

Orders are always imported to the default client

4. Installing the necessary plugins

To use idealo in plentymarkets, you need the following plugins:

  • idealo

  • Elastic Export
    Note: You also need the Elastic Export plugin if you export your item data to idealo via the interface PWS 2.0.

Adding and installing the plugin idealo in your plentymarkets system

Adding plugin to the system:

  1. Go to Plugins » plentyMarketplace.
    → The marketplace opens in a new tab.

  2. Navigate to the plugin idealo.
    Tip: Either use the search function or open the category Plugins » Sales » Marketplaces.

  3. Open the detail view of the plugin.

  4. In the column to the right, click on Go to checkout.
    → The Checkout window opens.

  5. Read and accept the General Terms and Conditions.

  6. Click on Order now.
    → Wait a few minutes before installing the plugin.

Installing plugins:

  1. Go to Plugins » Plugin set overview.

  2. Click on the plugin set in which you want to install the plugin.
    → The plugin set opens.

  3. Click on Add new plugin.

  4. Select idealo from the plugin list.

  5. Click on Install.
    → The plugin is installed.
    → The plugin set is shown.

  6. Switch the plugin active ().

  7. Save () the plugin set.
    Tip: Problems saving the plugin set? Click on Open details to show additional information.

Adding and installing the plugin Elastic Export in your plentymarkets system

Adding plugin to the system:

  1. Go to Plugins » plentyMarketplace.
    → The marketplace opens in a new tab.

  2. Navigate to the plugin Elastic Export.
    Tip: Either use the search function or open the category Plugins » Sales » Marketplaces.

  3. Open the detail view of the plugin.

  4. In the column to the right, click on Go to checkout.
    → The Checkout window opens.

  5. Read and accept the General Terms and Conditions.

  6. Click on Order now.
    → Wait a few minutes before installing the plugin.

Installing plugins:

  1. Go to Plugins » Plugin set overview.

  2. Click on the plugin set in which you want to install the plugin.
    → The plugin set opens.

  3. Click on Add new plugin.

  4. Select Elastic Export from the plugin list.

  5. Click on Install.
    → The plugin is installed.
    → The plugin set is shown.

  6. Switch the plugin active ().

  7. Save () the plugin set.
    Tip: Problems saving the plugin set? Click on Open details to show additional information.

5. Completing the idealo assistant

Use the assistant Base settings - idealo in the Setup » Assistants » Plugins » [Open client] menu to quickly and conveniently set up idealo in plentymarkets. Moreover, you set up the data transfer to OTTO Market. Keep the API access data at hand that you received from idealo.

Item data export via API

It is mandatory to go through the idealo Basic settings assistant if you export your items to idealo with PWS 2.0. The automatic item export can only be set up in this assistant.

Carrying out settings in the assistant:

  1. Go to Setup » Assistants » Plugins » [Open client].

  2. Click on the assistant idealo Basic settings.

  3. Follow the instructions on the screen. If you need additional information about one of the options, expand the info boxes shown below this instruction ().

  4. In the step Summary, check your settings to makes sure they are correct.
    Tip: Click on the arrow in the step Summary () to show the settings.

  5. If everything is as it should be, click on Finalise.
    → The settings are saved.

Step Basic settings
Setting Explanation

Enter the shop ID of the idealo shop that you would like to set up the user account for.

Enter the shop ID of your idealo store. Go to the idealo Business Portal to find the shop ID.

Select the platform that your idealo shop is set up for.

Select the platform from the drop-down list.

Select the client that should be used to export your items to idealo and to import your orders into plentymarkets.

From the drop-down list Client, select a client.
Step Automatic data transfer
Setting Explanation

Would you like to export your items to idealo via interface (Partner Web Service 2.0)?

Items can be exported to idealo via interface or via CSV file with the elastic export. Check with idealo how item data should be transferred before the setup in plentymarkets. Via interface, prices and stock will be transferred every fifteen minutes. The interval of data transfer with CSV export is defined by idealo.

Would you like to export your stock and prices?

Export stock and prices activated = Prices and stock are updated every 15 minutes.

Would you like to import your idealo Checkout orders into plentymarkets?

Activate to import orders every 15 minutes automatically.
Note: You need to activate this option to export item data and stock information.

What order status do you want to assign to idealo Checkout orders cancelled before the import?

Some idealo Checkout orders are cancelled before they are first imported to your plentymarkets system. Select the order status that is to be assigned to such cancelled orders during the import.
Note: The import of these cancelled idealo Checkout orders triggers the event procedures set up for the selected status. As such, select a status that does not trigger any event procedures (such as cancellation confirmations being sent to customers).

Do you want to continue processing open MOA 1.0 orders with this account?

The idealo Merchant Order API is a REST API for retrieving and processing idealo Checkout orders. In January 2021, idealo updated this REST API from version 1.0 to version 2.0. Activate this setting if you used this account to import orders with the old MOA 1.0 interface. Any open orders will then be processed automatically as usual. Ignore this setting if you are setting up a new idealo account.

What status should an order change to when customers request a cancellation?

Customers might only request a cancellation after an idealo Checkout order is already imported into your plentymarkets system. Such cancellation requests are imported into plentymarkets every 15 minutes. Select an order status that is assigned to these orders. A separate status allows you to view and process these orders individually.
Tip: Set up the event procedure Accept cancellation by buyer to process cancellation requests automatically.

Up to which status should requests for order cancellations by customers be considered?

Which orders cancelled by customers should be moved to the order status that you selected above? Set a limit for accepting cancellation requests.
→ Orders with this or a lower status are moved to the status you selected for What status should an order change to when customers request a cancellation? if customers request a cancellation.
→ Orders with a higher order status remain in their original status, i.e. are not moved into the status for orders cancelled by customers.
Step Access data
Setting Explanation

Enter the access data of your Merchant Order API 2.0 API client.

The API client access data is required to allow plentymarkets access to your idealo account so that the data exchange can be activated. For the API key, enter the token for the Merchant Order API v2. Go to the idealo Business Portal and generate the API key.

Enter the access data of your Partner Web Service 2.0 API client.

You need the API client access data so that plentymarkets can connect to your idealo account. This activates the exchange of item data. Generate the access data in idealo Business.
Step Item data
Setting Explanation

Select the item name that should be transferred to idealo.

Select Name 1, Name 2 or Name 3 from the drop-down list. This item name is transferred.
Tip: Item names are entered in the texts tab of the item.

Select the item description that should be transferred to idealo.

Select Item description, Preview text, Technical data or Item description and technical data from the drop-down list. This item description is transferred to idealo.

Select the URL that should be transferred to idealo.

The URL is required so that customers can be redirected from the price search engine to your plentyShop. Variation URLs can only be transferred if you use the Ceres plentyShop. Item URL Variation URL

Which price would you like to transfer to idealo as minimum price?

If you use the price range feature for idealo checkout sellers, you can specify a minimum price in addition to the regular sales price. Select the sales price form the drop-down list that you want to export as the minimum price. Visit the idealo  website to find out more about the price range feature.
Tip: You can only select sales prices from the drop-down list for which the referrer idealo has been activated.

  • Do not use minimum price = The price range feature is deactivated.
Step Attributes
Setting Explanation

Select the attributes that you have created in plentymarkets to specify colours for your items.

Activate the attributes that you use to create variations based on colour.

Select the attributes that you have created in plentymarkets to specify sizes for your items.

Activate the attributes that you use to create variations based on size.

What plentymarkets property do you use for the idealo energy efficiency attribute "Energy efficiency class"?
(plugin versions 3.3.5 and higher)

This property is used to export the energy efficiency class of products that need to be labelled.

Allowed values:

  • New energy efficiency scale (from 1st of March 2021):

    • A, B, C, D, E, F, G
      Example: C

  • Old energy efficiency scale (up to 28th of February 2021):

    • A+++, A++, A+, A, B, C, D, E, F, G
      Example: A+++

Note: You specify the energy efficiency scale used with the idealo attribute Version.

Create new property

Creates a property of the type Character string and links this property with the idealo attribute. When you link this property to a variation and save a value, this value is exported to idealo.
Tip: The property is saved in the property group idealo.

Link existing property

Select a property from the drop-down list. You can link a property of the types Character string or Selection. When you link this property to a variation and save a value, this value is exported to idealo.

Tip: Learn how to link properties to variations in the Linking properties and saving a value chapter.

What plentymarkets property do you use for the idealo energy efficiency attribute "Spectrum"?
(plugin versions 3.3.5 and higher)

This property is used to export the spectrum of available energy efficiency classes of products that need to be labelled. Use a minus sign to specify a range.

Allowed values:

  • New energy efficiency scale (from 1st of March 2021):

    • A, B, C, D, E, F, G
      Example: A-G

  • Old energy efficiency scale (up to 28th of February 2021):

    • A+++, A++, A+, A, B, C, D, E, F, G
      Example: A+++-G

Background: The spectrum depends on the device type. For example, a spectrum of A to D is used for household washing machines. However, for household refrigerating appliances, the spectrum range is A to G.

Create new property

Creates a property of the type Character string and links this property with the idealo attribute. When you link this property to a variation and save a value, this value is exported to idealo.
Tip: The property is saved in the property group idealo.

Link existing property

Select a property from the drop-down list. You can link a property of the types Character string or Selection. When you link this property to a variation and save a value, this value is exported to idealo.

Tip: Learn how to link properties to variations in the Linking properties and saving a value chapter.

What plentymarkets property do you use for the idealo energy efficiency attribute "Link to label"?
(plugin versions 3.3.5 and higher)

This property is used to export links to image files that contain the energy efficiency labels of products that need to be labelled.
Example: http://www.link.to/label.jpg
Important: Make sure that the image’s resolution is high enough to allow customers to scan the label’s QR code.

Create new property

Creates a property of the type File and links this property with the idealo attribute. When you link this property to a variation and save a value, this value is exported to idealo.
Tip: The property is saved in the property group idealo.

Link existing property

From the drop-down list, select a property of the type File. When you link this property to a variation and save a value, this value is exported to idealo.

Tip: Learn how to link properties to variations in the Linking properties and saving a value chapter.

What plentymarkets property do you use for the idealo energy efficiency attribute "Link to data sheet"?
(plugin versions 3.3.5 and higher)

This property is used to export links to PDF files that contain the EEK data sheets of products that need to be labelled.
Example: http://www.example.com/datasheet.pdf

Create new property

Creates a property of the type File and links this property with the idealo attribute. When you link this property to a variation and save a value, this value is exported to idealo.
Tip: The property is saved in the property group idealo.

Link existing property

From the drop-down list, select a property of the type File. When you link this property to a variation and save a value, this value is exported to idealo.

Tip: Learn how to link properties to variations in the Linking properties and saving a value chapter.

What plentymarkets property do you use for the idealo energy efficiency attribute "Version"?
(plugin versions 3.3.5 and higher)

This property is used to specify if the data that you export with the other idealo attributes is based on the old or the new energy efficiency scale.

Allowed values:

  • 0 = Old energy efficiency scale (up to 28th of February 2021)

  • 1 = New energy efficiency scale (from 1st of March 2021)

Create new property

Creates a property of the type Whole number and links this property with the idealo attribute. When you link this property to a variation and save a value, this value is exported to idealo.
Tip: The property is saved in the property group idealo.

Link existing property

Select a property from the drop-down list. You can link a property of the types Character string, Whole number, Decimal number, or Selection. When you link this property to a variation and save a value, this value is exported to idealo.

Tip: Learn how to link properties to variations in the Linking properties and saving a value chapter.
Step Payment methods
Setting Explanation

idealo payment methods

Activate the payment methods that you want to offer for idealo orders.
Step Shipping methods
Setting Explanation

Link plentymarkets shipping service provider DHL with:

For each of your shipping profiles, select an idealo shipping method from the drop-down list.
Tip: If no shipping profiles are displayed, then you have not set up any shipping profiles for the referrer idealo and the target shipping country in plentymarkets yet. You can create shipping profiles with the assistant Shipping settings.
Step Activate user account
Setting Explanation

Would you like to activate your idealo user account now?

Not activated = The settings are saved but the data exchange with idealo is not started.
Activated = Data exchange with idealo is started once the assistant is completed.
Recommendation: Only activate the user account after you have checked all settings and are ready to start the data exchange with idealo.

Would you like to copy existing SKUs from the old idealo interface to your new user account?

Activate the option Copy existing SKUs if you already sell on idealo. This prevents duplicate items on idealo.
Note: Do not activate this option if you have just started selling on idealo. In this case, SKUs are newly generated based on variation IDs.

6. Using idealo price comparison and idealo Checkout

Depending on whether you only want to use the idealo price comparison or whether you want to enable your customers to buy items directly at idealo without having to enter your plentyShop, different settings must be carried out. The overview below lists the settings required for idealo Checkout.

Settings for idealo Checkout:

  • Basic settings: Go through the assistant Base settings - idealo in the Setup » Assistants » Plugins » [Open client] menu.

  • Item export: Set up the automatic item export or the item data export via CSV file, depending on how you want to export your items to idealo.

  • Order referrer: In addition to the order referrer idealo, also activate the order referrer idealo Checkout in the Setup » Orders » Order referrer menu.

  • Variation availability: In addition to the order referrer idealo, also activate the order referrer idealo Checkout in the Markets area of the Item » Edit item » [Open item] » [Open variation] » Tab: Availability menu.

  • Sales price: Set up a sales price.

  • SKU: Add SKUs if needed.

  • Characteristics: Create characteristics for idealo Checkout. Item characteristics, shipping methods and fees are transferred to idealo Checkout with characteristics.

  • Event procedures: Set up event procedures to automatically inform idealo about changes in the order status.

7. Activating the order referrer

An order referrer tags an order with the sales channel on which the order was generated. You also need to activate the order referrer in order to link items, characteristics etc. with {market}. Go to Setup » Orders » Order referrer to activate the order referrer.

Activating the order referrer for idealo price comparison:

  1. Go to Setup » Orders » Order referrer.

  2. Activate the option idealo.

  3. Optional: To use idealo Checkout, also activate the order referrer idealo Checkout.
    → If you activate the order referrer idealo Checkout, the column checkout_approved in the CSV file that is generated in the elastic export is set to true.

  4. Save () the settings.

8. Setting the variation availability

You need to activate the variations that you want to sell on idealo. This is done in the Availability tab of a variation within the Item » Edit item » [Open item] » [Open variation] menu.

Making a variation available for idealo:

  1. Go to Item » Edit item » [Open item] » [Open variation].
    → The tab Settings of the variation is shown.
    Tip: To sell all variations of an item on idealo, carry out the settings for the item’s main variation. This activates the availability of all variations of the item.

  2. In the Availability area, activate the option Active.

  3. Click on the Availability tab.

  4. In the Markets area, click in the selection field.
    → A list of all available markets is displayed.

  5. Activate the option idealo.

  6. Activate the option Web API.

  7. Optional: If you want to use idealo Checkout, also activate the option* idealo Checkout*.

  8. Click on Add ().
    → The market is added.

  9. Save () the settings.
    → The variation is available for idealo.

The variation group function allows you to edit several variations at once. You select the variations that you want to edit.

Making several variations available for idealo using the variation group function:

  1. Go to Item » Edit item.

  2. Set the filter Table type to Variations.

  3. Choose additional filters on the left if needed and click on Search ().

  4. Select () the variations to be edited from the overview on the right.

  5. Click on Variation group function.
    → The Variation group function window opens.

  6. Navigate to the area Market availability.

  7. Activate the checkbox to the left of the option idealo.

  8. Activate the checkbox to the right of the option idealo.

  9. Activate the checkbox to the left of the option Web API.

  10. Activate the checkbox to the right of the option Web API.

  11. Optional: If you want to use idealo Checkout, also activate the checkboxes to the left and right of the option idealo Checkout.

  12. Navigate to the area Availability.

  13. Activate the checkbox to the left of the option Active.

  14. Activate the checkbox to the right of the option Active.

  15. Click on Execute to apply the settings.

Batch processing allows you to edit several variations at once. You use filters to limit which variations are edited.

Making several variations available for idealo using batch processing:

  1. Go to Item » Batch processing.

  2. Click on the tab Variations in the upper left corner.

  3. Use the filters on the left to specify which variations should be processed.

  4. Navigate to the area Market availability.

  5. Activate the checkbox to the left of the option idealo.

  6. Activate the checkbox to the right of the option idealo.

  7. Activate the checkbox to the left of the option Web API.

  8. Activate the checkbox to the right of the option Web API.

  9. Optional: If you want to use idealo Checkout, also activate the checkboxes to the left and right of the option idealo Checkout.

  10. Navigate to the area Availability.

  11. Activate the checkbox to the left of the option Active.

  12. Activate the checkbox to the right of the option Active.

  13. Click on Apply to apply the settings to the variations.

9. Defining a sales price

Proceed as described below to define a sales price for the order referrer idealo. This price is displayed on idealo. It is valid for the idealo price comparison and idealo Checkout.

Sales prices define the conditions under which a variation is sold at a specific price and on a specific sales channel. That means that to sell variations on idealo price comparison, you need a sales price in which the order referrer idealo price comparison is activated. The price that you save for this sales price is the price that will be shown on idealo price comparison.

Defining a sales price for idealo price comparison:

  1. Go to Setup » Item » Sales prices » [Open sales price].
    Tip: No sales prices? Then create a new sales price first.

  2. Open the Settings tab.

  3. Activate the referrer idealo price comparison.

  4. Save () the settings.

Minimum price

If you want to use a minimum price for the "price range" feature for idealo, then you have to define at least two sales prices for idealo: a minimum price and a standard sales price. The minimum price must have the price type Special offer and must be linked to the referrer idealo Checkout.
Which price should be transferred to idealo as minimum price is defined with the setting Which price would you like to transfer to idealo as minimum price? in the Item data step of the idealo assistant.
The "price range" feature must also be activated at idealo.

10. Optional: Saving SKU

SKU are generated automatically when your variations are exported. However, you can also save market specific SKU for variations that you want to sell on this market instead.

  1. Go to Item » Edit item » [Open item] » [Open variation] » Tab: Settings.

  2. Click on the Availability tab.

  3. In the SKU area, click on Add ().
    → The New SKU window opens.

  4. Select the referrer idealo.

  5. Enter the SKU.

  6. Click on Add ().
    → The SKU is saved and displayed.

Only the most important settings for the import are described here. Is this your first time working with the import tool? Then get familiar with how data imports work in plentymarkets first.

  • Create a CSV file with at least the columns described in Table 2.

  • Create an import with the following settings:

    • Select the type Item.

    • Select the matching field Variation ID.

    • Map the plentymarkets data fields as described in Table 2.

Table 2. Recommended columns of the import file
Column in CSV file Explanation plentymarkets data field for mapping

Variation ID

Enter the variation ID in this column.

Variation ID

Market ID

Enter the referrer ID 121 in this column.

SKU > Marketplace ID

Account ID

This market does not require a marketplace account. As such, enter the number 0 in this column.

SKU > Marketplace ID

SKU

Enter the SKU that you want to save for the variation for this market in this column.

SKU > SKU

If you want to use idealo Checkout, also add SKUs with the referrer idealo Checkout.

11. Setting up the item export

Items can be transferred to idealo with the automatic item data export via API (PWS 2.0 interface) or via a CSV file with the elastic export. Depending on how you want to transfer your items to idealo, different settings are required.

Data transfer to idealo

Check with idealo how item data should be transferred before the setup in plentymarkets.

Information about the different types of data transfer is available in Table 3.

Table 3. idealo data transfer
Item data export via API (PWS 2.0) Item data export via elastic export

Item data export via interface

Item data export via CSV file

Unlimited number of items can be transferred

To transfer more than 9999 items to idealo, the option Generate cache file must be activated in the Elastic Export settings. If the option Generate cache file is activated, the output file will only be generated every 24 hours. This is to save resources.
Note: We recommend that you do not activate the option Generate cache file for more than 20 export formats. This is to ensure a high performance of the elastic export.

Items are created once a day

Retrieval of item data via URL that is saved at idealo

Price updates every 15 minutes

Time interval for retrieval of item data is defined by idealo

Stock updates every 15 minutes

Time interval for retrieval of item data is defined by idealo

Orders are imported to the selected client

Orders are always imported to the default client

11.1. Item data export via API (PWS 2.0)

If you want to transfer your items to idealo via API, go through the idealo Basic settings assistant in the Setup » Assistants » Plugins » [Open client] menu and activate the automatic item data export. Apart from the assistant, no further settings are required to set up the automatic item export in plentymarkets.

If you transfer your items via API, items will be created at idealo once per day. Prices and stock are updated every 15 minutes. Items can also be deleted every 15 minutes.

11.2. Item data export via elastic export

If you export items via the elastic export, you have to carry out a few settings in the Data » Elastic export menu to set up the export format. In order to use the elastic export, the Elastic Export  plugin must be installed in your plentymarkets system. First create the data format IdealoDE and afterwards transfer the URL to idealo so that idealo will be able to retrieve your item data.

How to set up the elastic export to export your items to idealo is described in the following chapters Setting up the data format IdealoDE plugin in plentymarkets and Available columns for the export file.

11.2.1. Setting up the data format idealo-Plugin in plentymarkets

Settings only for elastic export

The settings described in this chapter only need to be carried out if you transfer your items to idealo with the elastic export.
Check idealo product CSV

Not all of the columns of idealo’s product CSV are available in plentymarkets at present. Check whether you need columns which are not yet available in plentymarkets prior to setting up idealo in plentymarkets. In this case, an integration of idealo is currently not possible.
An overview of the columns which are available in plentymarkets can be found in the Available columns for the export file chapter.

Set up the export format IdealoDE so that your items can be exported to idealo with the elastic export. For further information about the elastic export, refer to the Elastic Export page. It is required to install the Elastic export plugin from the plentyMarketplace first before you can use the format IdealoDE for the elastic export.

Creating a new export format:

  1. Go to Data » Elastic export.

  2. Click on New export.

  3. Carry out the desired settings. Pay attention to the explanations given in Table 4.

  4. Save () the settings.
    → The export format IdealoDE-Plugin is given an ID and it appears in the overview within the Exports tab.

The following table lists details for settings, format settings and recommended item filters for the format IdealoDE plugin.

Table 4. Format settings for IdealoDE
Setting Explanation

Settings

Name

Enter a name. The export format is listed by this name in the overview within the Exports tab.

Type

Select the type item from the drop-down list.

Format

Select IdealoDE-Plugin.

Limit

Enter a number. This number determines how many items are exported at maximum.

Note: Do you want to transmit more than 9999 items to idealo?

  • Then the output file will only be generated every 24 hours. This is to save resources.

  • Then also select the option Generate cache file further below.

Tip: If you want to transfer more than 9999 items to idealo, you can also install version 2.0 of the idealo plugin.

Generate cache file

Activate if you want to transfer more than 9999 items to idealo. If the option is activated, the output file will only be generated every 24 hours. This is to save resources.
Note: We recommend that you do not activate this option for more than 20 export formats. This is to ensure a high performance of the elastic export.

Provisioning

Select URL.

File name

The file name must have the ending .csv or .txt for idealo.de to be able to import the file successfully.

Token, URL

If you selected the option URL under Provisioning, click on Generate token. The token is entered automatically. The URL is entered automatically if the token was generated under Token.

Item filters

Add item filters

Select an item filter from the drop-down list and click on Add. There are no filters set by default. It is possible to add multiple item filters from the drop-down list one after the other.

  • Variations = Transfer all or Only transfer main variations.

  • Markets = Select idealo.

  • Currency = Select a currency.

  • Category = Activate to transfer the item with its category link. Only items belonging to this category will be transmitted.

  • Image = Activate to transfer the item with its image. Only items with images will be exported.

  • Client = Select a client.

  • Stock = Select which stocks you want to export.

  • Flag 1 - 2 = Select a flag.

  • Manufacturer = Select one, several or ALL manufacturers.

  • Active = Only active variations will be exported.

Format settings

Product URL

Select the URL that you wish to transfer to the price search engine. You can either send the item’s URL and the variation’s URL. URLs of variations can only be transferred in combination with the Ceres plentyShop.

Client

Select a client. This setting is used for the URL structure.

URL parameter

Enter a suffix for the product URL if this is required for the export. If you activated the transfer option for the product URL further up, then this character string is added to the product URL.

Order referrer

Select the referrer idealo. The selected referrer is added to the product URL so that sales can be analysed later.

Marketplace account

Select the marketplace account from the drop-down list.

Language

Select the language from the drop-down list.

Item name

Select Name 1, Name 2 or Name 3. The names are saved in the Texts tab of the item. Enter a number into the Maximum number of characters (def. text) field if desired. This specifies how many characters are exported for the item name.

Preview text

Select the text that you want to transfer as preview text.
Enter a number into the Maximum number of characters (def. text) field if desired. This specifies how many characters are exported for the preview text.
Activate the Remove HTML tags option if you want HTML tags to be removed during the export.
If you only want to allow specific HTML tags to be exported, then enter these tags into the * Permitted HTML tags, separated by comma (def. text)* field. Use commas to separate multiple tags.

Description

Select the text that you want to transfer as description.
Enter a number into the Maximum number of characters (def. text) field if desired. This specifies how many characters are exported for the description.
Activate the Remove HTML tags option if you want HTML tags to be removed during the export.
If you only want to allow specific HTML tags to be exported, then enter these tags into the * Permitted HTML tags, separated by comma (def. text)* field. Use commas to separate multiple tags.

Target country

Select the target country from the drop-down list.

Barcode

Select the ASIN, ISBN or an EAN from the drop-down list. The barcode has to be linked to the order referrer selected above. Otherwise, the barcode will not be exported.

Image

Select Position 0 or First image to export this image.

  • Position 0 = An image with position 0 is transferred.

  • First image = The first image is transferred.

Image position of the energy label

Enter the position of the energy label. Every image that should be transferred as an energy label has to have this position.

Stock buffer

The stock buffer for variations with limitation to the net stock.

Stock for variations without stock limitation

The stock for variations without stock limitation.

Stock for variations with no stock administration

The stock for variations without stock administration.

Live currency conversion

Activate this option to convert the price into the currency of the selected country of delivery. The price has to be released for the corresponding currency.

Sales price

Select gross price or net price from the drop-down list.

Offer price

This option does not affect this format.

RRP

Activate to transfer the RRP.

Shipping costs

The chosen payment method does not affect this format. All payment methods of the selected configuration will be exported.
If no configuration has been selected, all configurations and payment methods will be exported.
If Transfer flat rate shipping charge has been selected, only prepayment will be exported as the payment method.

VATNote

This option does not affect this format.

Item availability

Activate the overwrite option and enter item availabilities into the fields 1 to 10. The fields represent the IDs of the availabilities. This overwrites the item availabilities that are saved in the Setup » Item » Availability menu.

11.2.2. Available columns for the export file

Table 5. Columns for the export file
Column header Explanation

article_id

Required
The SKU of the item. For all items which are configured for idealo Checkout, a SKU will be generated for idealo Checkout.

deeplink

Required
The URL path of the item depending on the chosen client in the format settings.

name

Required
According to the format setting Item name.

short_description

According to the format setting Preview text.

description

Limitation: max. 1000 characters
According to the format setting Description.

article_no

The variation number as per Item » Edit item » [Open item] » [Open variation] » Settings » Basic settings.

producer

The name of the manufacturer of the item. The external name saved in the Setup » Item » Manufacturers menu is preferred if existing.

model

The model as per Item » Edit item » [Open item] » [Open variation] » Settings » Basic settings.

availability

Required
The name of the item availability saved in the Setup » Item » Availability menu or the translation according to the format setting Overwrite item availability.
For idealo, the delivery time must be indicated in days.

ean

According to the format setting Barcode.

isbn

According to the format setting Barcode.

fedas

The Amazon product type as per Items » Edit item » [Open item] » Multi-Channel » Amazon.

warranty

Currently not configured.

price

Required
The sales price of the variation.

price_old

The sales price of type RRP of the variation, if activated in the format settings.

weight

The gross weight in gram as per Items » Edit item » [Open item] » [Open variation] » Settings » Measurements.

category1-6

The name of the category level of the category path of the default category for the client which is configured in the format settings.

category_concat

The category path of the default category for the client which is configured in the format settings.

image_url_preview

The URL for the image which is scaled for preview according to the format setting Image.

image_url

Required
URL of the image according to the format setting Image.

base_price

The base price information in the format "price / unit".
Example: 10.00 EUR / kilogram

free_text_field

The value of a characteristic of the type Text or Selection with a link to idealo.

checkoutApproved

Is true if the order referrer idealo Checkout is activated in the Items » Edit item » [Open item] » [Open variation] » Availability » Markets menu or if a characteristic of the type No and the link to the idealo Checkout characteristic CheckoutApproved is configured.

itemsInStock

Requirement: checkoutApproved is true.
The net stock of the variation. For items which are not limited to the net stock, 999 will be exported.

fulfillmentType

Requirement: checkoutApproved is true.
Characteristic of type No with link to one of the options for the idealo Checkout characteristic FulfillmentType > Spedition, FulfillmentType > Paketdienst, FulfillmentType > Brief or FulfillmentType > Download.

twoManHandlingPrice

Requirement: checkoutApproved is true and fulfillmentType is “Spedition”.
Characteristic of type Text, Selection or float and the link to the idealo Checkout characteristic twoManHandlingPrice.

disposalPrice

Requirement: checkoutApproved is true and fulfillmentType is “Spedition”.
Characteristic of type Text, Selection or float and the link to the idealo Checkout characteristic disposalPrice.

Payment methods

Requirement: at least one payment method
All payment methods will be exported, according to the format setting Shipping costs in their own column.

12. Activating the payment method idealo Checkout

As soon as an active account for idealo exists, the payment method idealo Checkout is automatically available in your plentymarkets system. No separate configurations are needed for this. You just need to permit the payment method in one or more customer classes.

Permitting the payment method in a customer class:

  1. Go to Setup » CRM » Classes.

  2. Open the customer class for which you want to permit the payment method.

  3. For the setting Permitted payment methods, activate the option idealo Checkout.

  4. Save () the settings.

PayPal payment method

If you offer the payment method PayPal, it is mandatory to create and configure this payment method in your plentymarkets system. This is to ensure that the payment is imported and assigned to the order correctly.

13. Creating characteristics

Use characteristics to link specific item details to your items which are required to set up idealo Checkout. Item details, shipping methods and fees are transferred to idealo Checkout with characteristics.

Characteristics can only be used with the idealo plugin version 2.0

The characteristics DeliveryComment, DepositFee, DisposalPrice, EnergyClass, FreeReturnDays, Gender, Material, and Replica can only be used if the idealo plugin version 2.0 is installed in your plentymarkets system. These characteristics can only be exported to idealo Checkout if you activate the automatic item export (data export via interface). The automatic item export is activated in the Automatic data transfer step of the idealo assistant.
If the automatic item export is activated, you can export all idealo characteristics.
If you transfer your items with via CSV file with the elastic export, you can only use the characteristic FulfillmentType.

13.1. Creating the characteristics material and gender

Use the characteristics Material and Gender to transfer information about material and target group or gender to idealo Checkout.

Proceed as described below to create the characteristic Material. Create the Gender characteristic in the same way, but select the characteristic type Text instead.

Creating a characteristic for material:

  1. Go to Setup » Item » Characteristics » Tab: New characteristic.

  2. Enter the Name (internal).

  3. Select the characteristic type No from the characteristic type drop-down list.

  4. Select the characteristic Material for idealo Checkout characteristic.

  5. Save () the settings.

Next, you have to link the characteristic to the item in the Item » Edit item » [Open item] » [Open variation] » Variation tab: Characteristics menu.

13.2. Creating characteristics for shipping methods

With idealo Checkout, the customer buys the items directly at idealo and you have to send shipping information to idealo Checkout. If you ship your items with a parcel service, a shipping company, via letter or via download, this mandatory information is transferred to idealo with a characteristic. If the order is carried out by a shipping company, the customer has to enter their phone number during the order process in order to arrange a delivery date.

Proceed as described below to create the characteristic FulfillmentType. This characteristic indicates whether you use the shipping method shipping company, parcel service, letter, or download.

Creating a characteristic for the shipping method:

  1. Go to Setup » Item » Characteristics » Tab: New characteristic.

  2. Enter the Name (internal).

  3. Select the characteristic type No from the characteristic type drop-down list.

  4. Select the characteristic FulfillmentType for idealo Checkout characteristic.
    → A drop-down list is shown.

  5. Select a value from the drop-down list, depending on the shipping type. The values Spedition (shipping company), Paketdienst (parcel service), Brief (letter), and Download (download) are available.

  6. Save () the settings.

Next, you have to link the characteristic to the item in the Item » Edit item » [Open item] » [Open variation] » Variation tab: Characteristics menu.

Further characteristics for shipping methods

For items which have the shipping method shipping company, it is also possible to transfer the additional services TwoManHandlingPrice and DisposalPrice to idealo Checkout. DisposalPrice can only be used in combination with TwoManHandlingPrice. That means you have to create the characteristic TwoManHandlingPrice as well as the property DisposalPrice and link them to the item. In both cases, select decimal number as the characteristic type. Go to Item » Edit item » [Open item] » [Open variation] » Variation tab: Characteristics and enter the surcharge for the additional service with two decimal places behind the decimal separator. Use a period for the decimal separator (19.99).

13.3. Creating a characteristic for delivery comments

Use the characteristic DeliveryComment to transfer further information about the delivery.

Proceed as described below to create the characteristic DeliveryComment.

Creating a characteristic to specify further information about the delivery:

  1. Go to Setup » Item » Characteristics » Tab: New characteristic.

  2. Enter the Name (internal).

  3. Select Text from the characteristic type drop-down list.

  4. Select the characteristic DeliveryComment for idealo Checkout characteristic.

  5. Save () the settings.

Next, you have to link the characteristic to the item in the Item » Edit item » [Open item] » [Open variation] » Variation tab: Characteristics menu.

13.4. Creating the characteristic energy efficiency class

Use the characteristic EnergyClass to transfer information about the energy efficiency class to idealo Checkout.

For plugin versions 3.3.5 and higher, you only need the characteristic for the energy efficiency class if you export your item data using the elastic export. If you use the API (PWS 2.0) for exporting item data, you specify properties for exporting energy efficiency information in the assistant.

Proceed as described below to create the characteristic EnergyClass.

Creating the characteristic energy efficiency class:

  1. Go to Setup » Item » Characteristics » Tab: New characteristic.

  2. Enter the Name (internal).

  3. Select the characteristic type No from the characteristic type drop-down list.

  4. Select the characteristic EnergyClass for idealo Checkout characteristic.
    → A drop-down list is shown.

  5. Select a value from the drop-down list, depending on the energy efficiency class.

  6. Save () the settings.

Next, you have to link the characteristic to the item in the Item » Edit item » [Open item] » [Open variation] » Variation tab: Characteristics menu.

13.5. Creating the characteristic free return

Use the characteristic FreeReturnDays to transfer information about the free return period to idealo Checkout.

Proceed as described below to create the characteristic FreeReturnDays.

Creating a characteristic for the free return period:

  1. Go to Setup » Item » Characteristics » Tab: New characteristic.

  2. Enter the Name (internal).

  3. Select the characteristic type whole number from the drop-down list.

  4. Select the characteristic FreeReturnDays for idealo Checkout characteristic.

  5. Save () the settings.

Next, you have to link the characteristic to the item in the Item » Edit item » [Open item] » [Open variation] » Variation tab: Characteristics menu.

13.6. Creating the characteristic deposit fee

Use the characteristic DepositFee to transfer information about the deposit fee to idealo Checkout. This characteristic is required if a deposit fee must be paid for an item.

Proceed as described below to create the characteristic DepositFee.

Creating the characteristic deposit fee:

  1. Go to Setup » Item » Characteristics » Tab: New characteristic.

  2. Enter the Name (internal).

  3. Select the characteristic type decimal number from the drop-down list.

  4. Select the characteristic DepositFee for idealo Checkout characteristic.

  5. Save () the settings.

Next, you have to link the characteristic to the item in the Item » Edit item » [Open item] » [Open variation] » Variation tab: Characteristics menu.

13.7. Creating the characteristic replica

Use the characteristic Replica to specify whether the item is a replica.

Proceed as described below to create the characteristic Replica.

Creating the characteristic replica:

  1. Go to Setup » Item » Characteristics » Tab: New characteristic.

  2. Enter the Name (internal).

  3. Select the characteristic type No from the characteristic type drop-down list.

  4. Select the characteristic Replica for idealo Checkout characteristic.

  5. Save () the settings.

Next, you have to link the characteristic to the item in the Item » Edit item » [Open item] » [Open variation] » Variation tab: Characteristics menu.

14. Creating event procedures for idealo Checkout

Do you use idealo Checkout? Then set up event procedures to automatically inform idealo about changes in the order status. You can use event procedures to automatically send shipping confirmations, returns, and cancellations to idealo Checkout.

Event procedures for idealo Checkout only

You only have to set up event procedures if you use idealo Checkout.

14.1. Automatically sending shipping confirmations

Set up an event procedure to automatically send a shipping confirmation to idealo when the outgoing items have been booked.

Setting up an event procedure

  1. Go to Setup » Orders » Events.

  2. Click on Add event procedure ().
    → The Create new event procedure window opens.

  3. Enter a distinct Name for the event procedure.

  4. Select the Event according to Table 6.

  5. Save () the settings.

  6. Carry out the further settings according to Table 6.

  7. Activate the option Active ().

  8. Save () the settings.

Table 6. Event procedure for automatically sending shipping confirmations to idealo
Setting Option Selection

Event

Select an event, for example Order change: Outgoing items booked

Filter 1

Order > Order type

Order

Filter 2

Order > Referrer

idealo Checkout

Procedure

Plugins > Send shipping confirmation to idealo

14.2. Automatically sending returns

Set up an event procedure to automatically inform idealo about returns.

Setting up an event procedure

  1. Go to Setup » Orders » Events.

  2. Click on Add event procedure ().
    → The Create new event procedure window opens.

  3. Enter a distinct Name for the event procedure.

  4. Select the Event according to Table 7.

  5. Save () the settings.

  6. Carry out the further settings according to Table 7.

  7. Activate the option Active ().

  8. Save () the settings.

Table 7. Event procedure for automatically notifying idealo of returns
Setting Option Selection

Event

Select an event, for example Order generation: New return

Filter 1

Order > Order type

Return

Filter 2

Order > Referrer

idealo Checkout

Procedure

Plugins > Send return notification to idealo

14.3. Automatically sending cancellations

Set up an event procedure to automatically inform idealo of cancellations. The following actions are available for cancellations:

  • Send seller cancellation to idealo

  • Send buyer cancellation to idealo

14.3.1. Automatically sending seller cancellations

Setting up an event procedure

  1. Go to Setup » Orders » Events.

  2. Click on Add event procedure ().
    → The Create new event procedure window opens.

  3. Enter a distinct Name for the event procedure.

  4. Select the Event according to [cancellations-seller-idealo].

  5. Save () the settings.

  6. Carry out the further settings according to [cancellations-seller-idealo].

  7. Activate the option Active ().

  8. Save () the settings.

Table 8. Event procedure for automatically notifying idealo of cancellations by seller
Setting Option Selection

Event

Select an event, for example Status change: [8] Cancelled

Filter 1

Order > Order type

Order

Filter 2

Order > Referrer

idealo Checkout

Procedure

Plugins > Send seller cancellation to idealo

14.3.2. Automatically sending buyer cancellations

Setting up an event procedure

  1. Go to Setup » Orders » Events.

  2. Click on Add event procedure ().
    → The Create new event procedure window opens.

  3. Enter a distinct Name for the event procedure.

  4. Select the Event according to [cancellations-buyer-idealo].

  5. Save () the settings.

  6. Carry out the further settings according to [cancellations-buyer-idealo].

  7. Activate the option Active ().

  8. Save () the settings.

Table 9. Event procedure for automatically notifying idealo of cancellations by buyer
Setting Option Selection

Event

Select an event, for example Status change: [8.1] Cancelled by customer

Filter 1

Order > Order type

Order

Filter 2

Order > Referrer

idealo Checkout

Procedure

Plugins > Send buyer cancellation to idealo

14.3.3. Automatically accepting cancellation by buyer

Setting up an event procedure

  1. Go to Setup » Orders » Events.

  2. Click on Add event procedure ().
    → The Create new event procedure window opens.

  3. Enter a distinct Name for the event procedure.

  4. Select the Event according to Table 10.

  5. Save () the settings.

  6. Carry out the further settings according to Table 10.

  7. Activate the option Active ().

  8. Save () the settings.

Table 10. Event procedure for automatically accepting cancellations by buyer
Setting Option Selection

Event

Select an event, for example Status change. Select the status that you set in the assistant for orders that customers want to cancel.

Filter 1

Order > Order type

Order

Filter 2

Order > Referrer

idealo Checkout

Procedure

Plugins > Accept cancellation by buyer

14.4. Automatically sending refund notifications

Set up an event procedure to automatically inform idealo of refunds.

Payment method idealo Checkout Payments only

The event procedure Send refund notification to idealo only is triggered for orders that were paid using the payment method idealo Checkout Payments. The event procedure cannot be used for orders that were paid for using PayPal.
Setting up an event procedure

  1. Go to Setup » Orders » Events.

  2. Click on Add event procedure ().
    → The Create new event procedure window opens.

  3. Enter a distinct Name for the event procedure.

  4. Select the Event according to Table 11.

  5. Save () the settings.

  6. Carry out the further settings according to Table 11.

  7. Activate the option Active ().

  8. Save () the settings.

Table 11. Event procedure for automatically notifying idealo of credit notes
Setting Option Selection

Event

Select an event, for example Order generation: New credit note.

Filter 1

Order > Order type

Credit note

Filter 2

Order > Referrer

idealo Checkout

Procedure

Plugins > Send refund notification to idealo

15. Viewing the log

The Data » Log menu contains a history of processes that run via the idealo interface. Note that integrations and identifiers are only shown in the drop-down lists as filters after the process has run at least once.

For idealo, the following filters are recommended:

  • Identifier » ElasticExportIdealoDE

Filtering and checking log entries

  1. Go to Data » Log.

  2. In the column to the left, select appropriate filters from the drop-down lists.

  3. Optional: Select filters for dates and/or times to only show entries from a specific period.
    Tip: For further information about the filters, refer to the Data log page of the manual.

  4. Click on Search ().
    → The results are shown.

  5. Check all entries for the levels warning and error.
    Tip: Click on the entry to see details.

16. FAQ

16.1. Item data export via API (PWS 2.0)

Not all of my items are exported to idealo. What can I do?

If you transfer your items to idealo via API (PWS 2.0), but not all of your items have been exported, you can try to update the timestamp for market exports. Updating the timestamp might help because usually, only variations which have been updated within the last two days are exported to idealo.

Updating the timestamp for market exports:

  1. Go to Item » Batch processing.

  2. In the Procedures area, activate the option Update timestamp for market exports.

  3. Click on Apply ().
    → All items which are configured for idealo will be exported to idealo with the next item export.

To top