Inhalt:
Allgemeines
In diesem Dokument ist die Magento Schnittstelle näher beschrieben. Bei Fragen können sie sich gerne an unseren Support wenden. Die Kontaktdetails sind auf der Seite Logistikschnittstellen zu entnehmen.
Nachdem die Konfiguration der Anbindung geklärt ist, werden wir diese auf Wunsch für sie einrichten. Sie können dann Bestellungen in das Logistiksystem übergeben und erhalten Lagerbestände sowie Versandinformationen aus dem Logistiksystem.
Leistungsumfang
Implementierte Funktionen
Die Module Auftragsübernahme, Statusrückgabe inkl. Track&Trace sowie die Lagerbestandspflege sind implementiert.
Unterstützte Versionen
Magento ab Version 2.1 wird unterstützt. Die Schnittstelle ist zuletzt mit der Version 2.4 validiert worden.
Technische Anbindung
Die Anbindung ist über die Magento REST API Version 1 realisiert.
Voraussetzungen
Wir benötigen die gewünschten Einstellungen wie die Schnittstelle auf unserer Seite zu konfigurieren ist. Hierfür bitten wir um die Beantwortung der nachfolgenden Fragen unter dem Punkt "Konfigurationsoptionen der Schnittstelle".
Konfigurationsoptionen der Schnittstelle
Übertragungseinstellungen
| Option | Mögliche Werte | Standardwert | Bemerkung |
|---|---|---|---|
| Aufträge übertragen | ja/nein | ja | Aktiviert die Übernahme von Aufträgen. |
| Status & Sendungsdaten übertragen | ja/nein | ja | Aktiviert die Rückgabe von Status- und Sendungsdaten. |
| Lagerbestände übertragen | ja/nein | ja | Aktiviert die Übernahme von Lagerbeständen. |
Verbindung / Zugangsdaten / Verbindungsparameter
| Option | Mögliche Werte | Standardwert | Bemerkung |
|---|---|---|---|
| Magento URL | URL | Die Adresse ihres Magento Shops im Format http://mein-magentoshop.com oder falls ein gültiges Zertifikat installiert wurde alternativ auch mit https://mein-magentoshop.com. | |
| Consumer Key (Konsumentenschlüssel) | Key | Ihr Consumer Key für den API Zugriff. | |
| Consumer Secret (Konsumentengeheimnis) | Secret | Ihr Consumer Secret für den API Zugriff. | |
| Access Token (Zugriffstoken) | Token | Ihr Access Token für den API Zugriff. | |
| Access Token Secret (Zugriffstoken-Geheimnis) | Token Secret | Ihr Access Token Secret für den API Zugriff. | |
| Wartezeit | 0-65535 | 120 | Wartezeit in Sekunden für eine Serveroperation. Ist die Serveroperation innerhalb der Zeit nicht abgeschlossen, wird ein Fehler ausgelöst. Standard sind 2 Minuten (120 Sekunden). |
| Schreib-/Lesewartezeit | 0-65535 | 300 | Wartezeit in Sekunden für das Schreiben oder Lesen von Daten. Wird das Schreiben oder Lesen eines Datenstrom länger als die Wartezeit unterbrochen, löst das einen Fehler aus. Standard sind 5 Minuten (300 Sekunden). |
Statuskennzeichen
Die Steuerung erfolgt komfortabel durch das Statussystem für Bestellungen in Magento. Die Status Codes können in der Schnittstelle frei konfiguriert werden. Somit sind auch benutzerdefinierte Statuscodes realisierbar.
| Status | Status Code | Bemerkung |
|---|---|---|
| Freigabe für Versand | pending | Der Auftrag wird übertragen, wenn dieser Status gesetzt ist. |
| Gerade im Versand | processing | Die erfolgreiche Übertragung des Auftrags wird durch setzen dieses Status quittiert. Die Schnittstelle erstellt zusätzlich noch einen internen Kommentar mit weiteren Verarbeitungsinformationen. |
| Versendet | complete | Die erfolgreiche Rückmeldung von Sendungsdaten und des Verladezeitpunkts wird durch setzen dieses Status gekennzeichnet. Die Schnittstelle erstellt zusätzlich noch einen internen Kommentar mit weiteren Verarbeitungsinformationen. |
Ausschluss von der Datenübernahme
Magento kennt verschiedene Arten von Artikeln. Da über die Sperre in der Regel die Bundles selbst oder auch andere nicht logistisch relevante Artikel ausgeklammert werden sollen (z. B. virtuelle Artikel) wurde das über die Artikeltypen gelöst.
| Option | Typ | Standardwert | Mögliche Werte | Bemerkung |
|---|---|---|---|---|
| Einfacher Artikel | simple | nein | ja/nein | Ist diese Option aktiviert wird ein Artikel mit dieser Artikelart nicht durch die Schnittstelle übernommen. |
| Gruppen Artikel | grouped | ja | ja/nein | |
| Konfigurierbarer Artikel | configurable | nein | ja/nein | |
| Virtueller Artikel | virtual | ja | ja/nein | |
| Bündelartikel | bundle | ja | ja/nein | |
| Downloadartikel | downloadable | ja | ja/nein |
Versand
In der Schnittstellenkonfiguration kann optional eine Versandanweisung konfiguriert werden.
Nur falls mehr als eine Versandart verwendet wird, sind angaben erforderlich. Standardmäßig wird immer als versichertes Paket versendet.
Die Versandinformation wird aus dem Feld "shipping_description" in der Bestellung entnommen. Die Werte müssen für ein korrektes Matching exakt diesem Übergebenen wert entsprechen.
| Option | Mögliche Werte | Bemerkung |
|---|---|---|
| Abholung ab Lager | <Code der Versandart> | Die gewählte Versandmethode führt zu einer Bereitstellung der Waren zur Abholung ab Lager beim Dienstleister. Bitte geben sie pro Zeile die Bezeichnung der Versandart an, auf die diese Regel zutrifft. |
| Versicherter Versand | <Code der Versandart> | Die gewählte Versandmethode führt zu einem versicherten Versand beim Dienstleister. Bitte geben sie pro Zeile die Bezeichnung der Versandart an, auf die diese Regel zutrifft. |
| Unversicherter Versand | <Code der Versandart> | Die gewählte Versandmethode führt zu einem unversicherten Versand beim Dienstleister. Bitte geben sie pro Zeile die Bezeichnung der Versandart an, auf die diese Regel zutrifft. |
| Speditionsversand | <Code der Versandart> | Die gewählte Versandmethode führt zu einem versicherten Versand per Spedition beim Dienstleister. Bitte geben sie pro Zeile die Bezeichnung der Versandart an, auf die diese Regel zutrifft. |
| Interner Warenverkehr | <Code der Versandart> | Die gewählte Versandmethode führt zu einem internen Warenverkehr im Lager des Dienstleisters. Bitte geben sie pro Zeile die Bezeichnung der Versandart an, auf die diese Regel zutrifft. |
Zahlung
| Option | Mögliche Werte | Bemerkung |
|---|---|---|
| Zahlart für Nachname | <Bezeichnung> | Bezeichnung der Zahlart die zu einer Übergabe des Nachnamebetrags zum Geschäftspartner führt. Der offene Bruttogesamtbetrag der Bestellung wird als Einzugsbetrag für die Nachname übergeben. Bitte geben sie pro Zeile die Bezeichnung der Zahlart an, auf die diese Regel zutrifft. |
Die Zahlart wird aus dem Feld "additional_information" in dem Objekt "payment" in der Bestellung entnommen. Die Werte müssen für ein korrektes Matching exakt diesem Übergebenen wert entsprechen. Der Betrag wird aus dem Feld "total_due" der Bestellung entnommen.
Lagerbestand
Die Bestände aus dem Warenlager werden nach Magento übertragen. Der Bestand wird periodisch (Intervall einstellbar) im Artikel hinterlegt. Hat der Artikel keinen Bestand mehr wird das Merkmal "Lagerbestand" von "auf Lager" in "nicht auf Lager" geändert. Ist wieder ein Bestand vorhanden wird das Merkmal wieder umgestellt. Das vorgenannte Verhalten kann durch diese Einstellungen beeinflusst werden.
| Option | Mögliche Werte | Bemerkung |
|---|---|---|
| Lagerort | gültiges Lager in Magento | Dieser gewählte Lagerort wird für Lagerbestandsupdates genutzt. Nachdem die Shop URL und die Zugangsdaten hinterlegt sind, kann hier aus den in Magento eingerichteten Lagerorten ein Lager ausgewählt werden, das per Schnittstelle gepflegt wird. |
Verhalten der Schnittstelle
Nachfolgend haben wir ihnen zum besseren Verständnis, das Verhalten der Schnittstelle näher erläutert.
Übergabe von Aufträgen
Befindet sich der Auftrag im Status "Freigabe für Versand" wird dieser von der Schnittstelle übernommen. Nach der erfolgreichen Übernahme wird der Status "Gerade im Versand" gesetzt.
Ein bereits übernommener Auftrag wird erneut übertragen, wenn im Shop der Status "Freigabe für Versand" wiederholt gesetzt wird.
Fehler bei der Rückgabe von Status, Sendungsdaten und Lagerbeständen
Es wird versucht die Übertragung zu wiederholen, bis diese erfolgreich verläuft.
Rückmeldung von Sendungsdaten und der Versanddienstleisterinformation
Bei der Rückmeldung wird der genutzte Versanddienstleister gesetzt. Hierfür müssen diese in Magento entsprechend konfiguriert werden. Eine entsprechende Codeliste ist nachstehend beigefügt.
Außerdem werden die in den Packstücken enthaltenen Artikel mit der Versandmenge zurückgemeldet. Liegen keine Packstückinhaltsinformationen vor, wird immer der gesamte Auftrag (alle Positionen mit der bestellten Menge) zurückgemeldet.
Ist der Frachtführer in Magento nicht bekannt / angelegt kann die Sendungsinformation nicht zurückgemeldet werden und die Bestellung wird nicht erfolgreich abgeschlossen.
Codeliste für Magento zur korrekten Zuordnung der Frachtführer
| Code (carrier_code) | Frachtführer |
|---|---|
| dhl | DHL (DE) |
| deutsche_post | DEUTSCHE POST |
| spedition | SPEDITION |
| abholung | ABHOLUNG |
| intern | INTERN |
| 2_mann_handling | 2-MANN-HANDLING |
| ups | UPS |
| dpd | DPD |
| amz | Versand mit Amazon |
| post_austria | POST AUSTRIA |