Product export feed and API methods

The German version of this page can be found here.

Which software interfaces does idealo offer?

For idealo’s price comparison service, you can submit your shop’s product information either via idealo’s API for product data (in realtime) or alternatively via an exported feed (e.g. in CSV format). Use the same exported feed or product API to provide stock quantities and delivery options. Within the German feed you can enable your products for idealo’s Direct Checkout feature.

You can retrieve your idealo Direct Checkout orders for the german market via the API for order data (aka: idealo REST-order-API). This interface can also be used to send idealo notifications about order dispatches or any cancellations.

The APIs for order data and product data are two distinct interfaces that are to be implemented separately.

Overview of idealo’s interfaces:

  • API for product data (in realtime) or alternatively an product export feed (e.g. in CSV format)
  • API for order data (the idealo REST-order-API)

Recommended method: To manage your sales more accurately, we recommend using the API for product data, rather than sending us an exported feed (e.g. a CSV). This will enable you to amend your selling prices and stock quantities in realtime. Exported feeds, on the other hand, are usually only imported on idealo’s side once every half an hour.

Sending your shop’s product information to idealo:

Sending your product information to idealo is done via an exported feed (in CSV, TXT or XML format) or, preferably, via idealo’s API for product data, which enables you to amend your price and availability information in realtime. There are clear performance advantages associated with this: any information provided via an exported feed is usually only updated on idealo’s side once every half hour, in addition to the time your system requires to create the exported feed.

Many systems already come with an integrated solution that can be used for idealo’s price comparison service. Or, such a function can easily be implemented via an additional module.
Please click here to see which feed engine provider do support Direct Checkout for the german market.

Option 1 – API for product data
idealo will provide you with a web service that you can use to update your shop’s product data in realtime. This web service is called up via HTTPS and can be implemented using almost any programming language.
This API documentation is suitable for all markets idealo is operating in:

Option 2 – Exported feed (CSV, TXT or XML)
If you wish, you can simply drop an exported feed, created via your eCommerce system, onto an FTP or web server (HTTP). Be aware that for each country a separate export file needs to be provided to idealo.

To keep loading times and costs down, you may transfer your exported feeds in compressed ZIP or gZIP format. We also support password-protected directories.

German market (does include the option ´Direct Checkout´):

UK market:

French market:

Spanish market:

Italian market:

Austrian market:

 

How often should I update my exported feed?
Please update the feed several times a day. This is the only way to ensure that idealo’s users will see your up-to-date prices and availability information. This also helps prevent possible overselling and customer disappointment if the prices in your online shop differ from the information on idealo.

 

Managing your idealo Direct Checkout products:

Important: You can enable your products individually for idealo’s Direct Checkout via your exported product feed. You can also provide information on stock quantities and special delivery options, e.g. delivery of goods by a freight forwarder. If within the feed these fields or values are left blank across all of your products, idealo will enable your entire inventory for Direct Checkout.
We highly recommend the usage of our API for product data to send data in realtime to idealo.

 

You can retrieve order information for the German Direct Checkout feature via idealo’s “API for order data” – the idealo REST-order-API. The same interface is used to send your shipping and order status information back to idealo.

The REST-order-API is called up via HTTPS and uses JSON as an interchange format. All operations are implemented in such a way that they can be re-initiated if a call-up is unsuccessful.

 

Retrieving your idealo Direct Checkout orders:
You can retrieve any new orders via the REST-API and confirm receipt of these by returning an order number (as created by your system). Currently only new orders can be retrieved – a call-up of specific orders, including those already received by your eCommerce system, is not yet possible.

For each order, idealo will send the shopping basket details, with the prices valid at the time of purchase. We also send the invoice and delivery address, additional contact details, payment and delivery type, delivery promise information and the customer’s chosen delivery option.

Please configure your sales tax rates yourself within your order management system(s).
idealo does not have comprehensive knowledge of your tax duties.

Will payment status also be sent?
Payment status information is called up via the interfaces of the respective payment service providers, and therefore is not covered by the API for order data. To enable your system to allocate payment transactions to an order, the relevant transaction ID from the payment service provider will be provided via the API.


Sending shipping status information to idealo:
Once you have passed a shipment to the parcel service or freight forwarder, you can use the API for order data to send idealo the shipping information for each order, including the shipping service and parcel / tracking number.

 

Sending details of cancellations and returns to idealo:
You can also use the API for order data to inform idealo of cancellations, partial cancellations or returns.

 

PHP example – Software Development Kit (SDK) for API connection:
To make it easier to connect the idealo Direct Checkout to a PHP-based system, idealo provides a PHP SDK which simplifies the API connection. The SDK contains a library for calling up the aforementioned API functions and a ready-to-run test application, which you can use to test all API operations in your own personal sandbox. On request, idealo will send you the sandbox data with the relevant test orders once you have registered for the idealo Direct Checkout.