Exportdatei & API

Inhalt

Angebotsdaten an idealo übertragen

Die Übertragung von Angebotsdaten an idealo erfolgt über eine Exportdatei (CSV, TXT, XML) oder unsere API für Angebotsdaten. Die Bereitstellung über die idealo API für Angebotsdaten hat u.a. den Vorteil, dass Preis- und Verfügbarkeitsänderungen in Echtzeit an uns gemeldet und weiterverarbeitet werden können, während die per Exportdatei bereitgestellten Daten in der Regel nur alle 30 Minuten aktualisiert werden.

Die Bereitstellung von Angebotsdaten per Exportdatei bzw. über die idealo API für Angebotsdaten ist bereits in zahlreichen Shop-Plugins integriert. Bei vielen Shop-Systemen ist die Bereitstellung der Angebotsdaten per Exportdatei auch ohne zusätzliches Plugin möglich.

Exportdatei (CSV, TXT, XML)

Sie können Ihre Exportdatei auf einem Server bereitstellen und von idealo per FTP oder HTTP abgerufen lassen.

> Informationen zum Aufbau der Exportdatei herunterladen (PDF, Deutsch)
> Beispiel Exportdatei herunterladen (XLS, Deutsch)

> Informationen zum Update der Exportdatei für idealo Direktkauf herunterladen (PDF, Deutsch)

Um unseren Kunden stets aktuelle Preise und Verfügbarkeiten anzeigen zu können, benötigen wir regelmäßig aktualisierte Angebotsdaten. Idealerweise generieren Sie mehrmals täglich Ihre Exportdatei.

Am einfachsten ist es, wenn Sie uns Ihre Exportdatei auf einem FTP- oder Webserver zur Verfügung stellen. idealo kann Ihnen auch ein passwortgeschütztes FTP-Konto bereitstellen.

Um Traffickosten und Ladezeiten zu verringern, können Sie uns Exportdateien komprimiert im ZIP- oder gZIP-Format übergeben. Wir unterstützen auch passwortgeschützte Verzeichnisse.

API für Angebotsdaten

idealo stellt Ihnen zwei Webservices zur Verfügung, mit denen Sie die Daten Ihrer Angebote in Echtzeit aktualisieren sowie Ihre aktuell an idealo übermittelten Angebote abrufen können.

Die Webservices können über HTTPS mit verschiedenen Programmiersprachen benutzt werden.

> Spezifikation der API für Angebotsdaten herunterladen (PDF, Deutsch)
> Spezifikation der API für Angebotsdaten herunterladen (PDF, Englisch)

Bestelldaten von idealo abholen

Die Übertragung von Bestelldaten von idealo in Ihr System erfolgt über unsere API für Angebotsdaten.

API für Bestelldaten

idealo stellt für die Übernahme von Bestellungen in Ihr System eine API für Bestelldaten zur Verfügung.

Über die API rufen Sie neue Bestellungen ab und bestätigen den Empfang, indem Sie die von Ihrem System vergebene Bestellnummer zurückmelden. Versand und Stornos bzw. Retouren melden Sie über die gleiche API an uns.

> Spezifikation der API für Bestelldaten herunterladen (PDF, Deutsch)

Funktionsweise

Die API für Bestelldaten wird über HTTPS angesprochen und verwendet JSON als Austauschformat. Sie wurde entwickelt, um die einfache Integration von idealo Direktkauf in beliebige Systeme zu ermöglichen. Die API für Bestelldaten unterstützt deswegen nur ein Minimum an Operationen. Eine Abfrage beliebiger, auch bereits in Ihr System übernommener Bestellungen, ist nicht möglich.

Robuste Fehlerbehandlung

Alle Operationen sind so implementiert, dass sie wiederholt aufgerufen werden können, das heißt: Wird ein API-Aufruf einmal nicht erfolgreich abgeschlossen, kann dieser zu einem späteren Zeitpunkt wiederholt werden. Schlägt zum Beispiel die Meldung des Versands für eine Bestellung wegen eines Netzwerkproblems fehl, kann die Versandmeldung mit dem gleichen Aufruf später erneut durchgeführt werden.

Bestellungen übernehmen

Sie erhalten über die API für Bestelldaten die Liste der aktuell offenen Bestellungen.

Zu jeder Bestellung übermittelt idealo den Warenkorb, die Rechnungs- und Lieferadresse sowie weitere Kontaktdaten, die Lieferart und gewählte Lieferoptionen wie z.B. „Zwei-Mann-Lieferung“ mit den zum Zeitpunkt der Bestellung gültigen Preisen. Zusätzlich übermitteln wir die gewählte Zahlungsart und die Zahltransaktion.

Die Abfrage des aktuellen Bezahlstatus erfolgt über die Schnittstellen der jeweiligen Payment Service Provider und ist nicht Bestandteil der API für Bestelldaten. Um die Zuordnung der Zahltransaktionen zur Bestellung in Ihrem System so leicht wie möglich zu machen, übermitteln wir einerseits mit der Bestellung die Transaktions-ID, andererseits ist die Bestellnummer in einem entsprechenden Attribut der Zahltransaktion hinterlegt, zum Beispiel die Invoice-ID bei PayPal.

Versandmeldung

Nach Übergabe einer Sendung an den Paketdienst oder die Spedition melden Sie über die API für Bestelldaten pro Bestellung den Versand samt Dienstleister und Paketnummer bzw. Tracking-Code. Die Versanddienstleister und Tracking-Codes können auch nachträglich durch erneutes Melden des Versands übergeben werden.

Storno / Retoure

Stornos und Retouren melden Sie nach Eingang in Ihrem System über die API an idealo. Dabei melden Sie bei Teilstornierungen jeweils die verbleibende Stückzahl an idealo. Wurden also ein Artikel 3 Mal bestellt, und 1 Exemplar ist als Retoure erfasst worden, melden Sie eine Retoure und als verbleibende Stückzahl 2.

SDK

Um die Anbindung von idealo Direktkauf an PHP-basierte Systeme zu erleichtern, stellen wir ein PHP-SDK bereit, das die API-Nutzung noch weiter vereinfacht. Das SDK enthält eine Bibliothek zum Aufruf der API und eine sofort lauffähige Test-Anwendung, mit der Sie alle API-Operationen in unserer Sandbox testen können.
> Zum PHP-SDK auf GitHub