Exported product feed & API
For the idealo price comparison, you transfer your product and offer data either via the idealo API for offer data (in real time) or via an export file/feed (e.g. CSV). Both possibilities also allow you to enable your offers for idealo Checkout as well as transmit inventory- and delivery options.
Selling internationally: in Germany, you can also sell your products via idealo’s Checkout, where the entire purchase takes place on the idealo platform.
Information on how to you the API: You can retrieve your idealo Checkout orders via the API for order data (aka. idealo REST Order API). This interface is also used to send idealo notifications about order dispatches or any cancellations.
The API for order data and the API for offer data are two different interfaces that must be implemented separately.
Overview of idealo’s interfaces:
Offer data can be transferred to idealo either manually, via an export file (CSV, TXT, XML) or via the idealo API for offer data.
The performance advantage of the API is obvious: Exported feeds (CSV, TXT or XML format) are usually updated every 30 minutes from idealo’s side.
Many eCommerce systems already come with an integrated solution that you can use to help set yourself up on idealo’s price comparison service. Alternatively, you can easily implement this function via an additional module.
Option 1 – Exported feed (CSV, TXT or XML format)
You can provide an exported feed, created via your eCommerce system, onto a FTP or web server (HTTP).
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.
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 any overselling, or customer disappointment if the prices in your webshop differ from the information seen on idealo.
Option 2 – API for product data
idealo can provide you with a web service that allows you to update your product and offer data in near real-time. The web service is addressed via HTTPS and uses JSON as the exchange format. The documentation of the REST API for offer data (idealo PWS 2.0) can be found here:
The following information only applies to you if you are looking to sell your products in Germany via idealo’s Checkout feature (where the entire purchase takes place on the idealo platform):
Required: You can use your exported product feed or the API for product data to specify which of your products you would like to set up on idealo’s Checkout, and to send idealo stock quantities and special delivery options (e.g. delivery by freight forwarder) for these products. If these fields / values are missing from all of your products, your entire inventory will be set up on idealo’s Checkout. You can also create your idealo Checkout offers manually in the idealo Business merchant area.
You can retrieve your idealo Checkout orders via the API for order data (aka. idealo REST Order API). You can also retrieve the idealo shipping and order status information
via the same interface.
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 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). It is only possible to retrieve new orders once – a call-up of any other order, including those already received by your eCommerce system, is not currently possible.
For each order, idealo will send the shopping basket details, with the prices valid at the time of purchase. We will also send the invoice and delivery addresses, additional contact details, payment and delivery types, delivery promise information and the customer’s chosen delivery option.
Please ensure that you configure your sales tax rates yourself within your system(s), as idealo does not have comprehensive knowledge of your tax duties.
Will the 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. However, the corresponding transaction ID from the payment service provider will be provided via the API, so that your system can allocate payment transactions to an order.
Sending shipping status information to idealo:
Once you have handed a shipment over to the parcel service or freight forwarder, you can use the API for order data to send idealo the shipping information for that order, including the shipping service used and parcel / tracking number.
Sending details of cancellations and returns to idealo:
The API for order data can also be used to inform idealo of any cancellations, partial cancellations or returns.
PHP example – Software Development Kit (SDK) for API connection:
To make it easier to connect the idealo Checkout to PHP-based systems, 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. Upon request, idealo will send you the sandbox data with the corresponding test orders once you have registered for the idealo Checkout.