API Log

Datenaustausch > API Log

Themen bzw. Einstellungen dieses Kapitels:

1) Info: API Log

2) API Schnittstellen-Dokumentation

3) Praxisbeispiele

3a) Anbindung eines Logistikdienstleisters

3b) Rechnungsabruf im PDF-Format

Wenn Sie Einträge, Einstellungen oder Änderungen vorgenommen haben, klicken Sie vor Verlassen eines Bereichs jeweils auf das Speichern-Symbol, um Ihre Konfiguration zu sichern.

1) Info: API Log

plentyMarkets verfügt über eine Schnittstelle zum Datenaustausch mit externen Softwaretools oder Dienstleistern in den Datenformaten XML und CSV. Die Nutzung der API ist nur dann interessant, wenn wirklich eine externe Softwarelösung an plentyMarkets angebunden werden soll. Wenn hingegen lediglich in unregelmäßigen Abständen Daten abgeglichen werden sollen, empfiehlt sich die Nutzung des Dynamischen Datenimports/-exports.

2) API Schnittstellen-Dokumentation

plentyMarkets und auch die plentyMarkets API werden regelmäßig weiterentwickelt. Nach einem plentyMarkets-Versionswechsel sollte die aktuelle Dokumentation auf Neuerungen überprüft werden. Einen Hinweis auf Neuerungen der API finden Sie auch schon vorab auf der Seite Changelog.

3) Praxisbeispiele

3a) Anbindung eines Logistikdienstleisters

In diesem Praxisbeispiel soll aufgezeigt werden, wie ein Datenaustausch über die plentyMarkets-API und mit einem externen Logistikdienstleister stattfinden kann. Ein externer Logistikdienstleister übernimmt die komplette Lagerhaltung und den Versand der Waren. Folglich müssen die in plentyMarkets befindlichen Artikelstammdaten mit dem System des Logistikanbieters abgeglichen werden, damit jener eine Einlagerung der Waren unter Verwendung der korrekten Artikel-ID (bzw. EAN oder Artikelnummer) vornehmen kann. Täglich muss ein Abgleich der zu versendenden Aufträge stattfinden und ein Rückimport der Paketnummern vorgenommen werden. Weiterhin muss das System des Logistikdienstleisters Warenbewegungen ebenfalls per API kommunizieren.

Hier eine Übersicht der Schnittstellenvorgänge für das gerade beschriebene Fallbeispiel:

  • Täglicher Abruf der Artikelstammdaten unter Verwendung von ArticleShortXML mit dem Paramter params[last_update]. Es soll erreicht werden, dass nur die Artikeldaten abgerufen werden, welche seit dem letzten Datenaustausch verändert oder hinzugefügt wurden.
  • Regelmäßiger Abruf der Aufträge über OrderXML durch Angabe eines bestimmten Auftragsstatus über params[sqlWhere][status] (Beispiel Status: 6.0). Die Angabe des Auftragsstatus muss hier flexibel gestaltet werden, da der Händler den Status selbst individuell anlegen und setzen lassen kann.
  • Direkt nach dem Abruf der Aufträge sollte der Status dieser Aufträge über SetOrderStatusXML umgestellt werden, damit die Aufträge nicht doppelt abgerufen werden (Beispiel Status 6.1).
  • Nach dem Versand sollte die Paketnummer per SetOrderPackagenumXML an plentyMarkets übergeben werden. In plentyMarkets kann dieses Ereignis abgefangen und dafür eine Aktion definiert werden. Sinnvoll: Versand einer E-Mail mit der Paketnummer an den Käufer und gleichzeitig Buchen des Warenausgangs.
  • Ein Import der Warenbewegungen ist über das Format StockXML möglich.

3b)  Rechnungsabruf im PDF-Format

Wenn der Lieferung ebenfalls die von plentyMarkets generierte Rechnung beigelegt werden soll, kann diese per URL-Aufruf abgefragt werden. Dazu sind lediglich die Parameter access_key und Order-ID nötig. Beide Parameter werden beim Abruf der Aufträge per OrderXML übergeben.

Schema der URL zum Abrufen einer Rechnung:

http://www.domain-des-plentymarkets-systems.de/index.php?ActionCall=WebActionGetPdfInvoice&ID=[access_key]&OID=[Order ID]&doc_type=0

In der API-Dokumentation finden Sie weitere Informationen und Beispiele zu den einzelnen Formaten.