...
Die Anbindung ist über die Magento REST API Version 1 realisiert.
Voraussetzungen
Zur Anbindung Wir benötigen wir die Shop URL, den Benutzernamen und den zugehörigen API-Schlüssel.Außerdem benötigen wir eine Vorgabe 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".
...
Ü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. Dadurch ist es möglich Aufträge manuell oder automatisiert freizugeben. Außerdem kann der Kunden durch den Shop bei einer Statusänderung automatisch benachrichtigt werden. Für die Schnittstelle sind unter System -> Bestellstati & -zustände sind folgende Stati zu ergänzen. Wenn es ihr Setup erfordert, können andere Stati Die Status Codes können in der Schnittstelle frei konfiguriert werden. Somit sind auch benutzerdefinierte Statuscodes realisierbar.
| Status | Status CodeZustandscode | Bemerkung | |||
|---|---|---|---|---|---|
| Freigabe für Versand | ffm_accept | processingpending | Der Auftrag wird übertragen, wenn dieser Status gesetzt ist. | ||
| Gerade im Versand | ffm_processingprocessing | Die erfolgreiche Übertragung des Auftrags wird durch setzen dieses Status quittiert. | Versendet | ffm_completeDie 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. In der Schnittstelle kann eingestellt werden, welche Artikeltypen von der Übernahme ausgenommen werden sollen. Da jeder Artikel einen entsprechenden Typ hat, ist das vom Standard her gegeben und leicht in der Prasis umsetzbar. Im Rahmen der Logistik werden üblicherweise nur einfache Artikel übernommen und die anderen Artikeltypen von der Übernahme ausgenommen.
| 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 | |
| Option | Mögliche Werte | Bemerkung | ||
| Downloadartikel | downloadable | ja/nein |
Lagerbestandsübertragung
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 |
|---|---|---|
| Setzen des Status lieferbar/nicht lieferbar deaktivieren | ja/nein | Das aktivieren dieser Option deaktiviert das Setzen des Mekrmals lieferbar / nicht lieferbar in Magento. Artikel ohne oder mit negativem Lagerbestand bleiben weiterhin bestellbar, wenn dieser Status nicht durch die Schnittstelle bei 0-Bestand gesetzt wird. |
Benachrichtigung
Die Übergabe von Sendungsdaten an den Besteller kann in der Schnittstelle aktiviert oder deaktiviert werden. Die eigentliche Benachrichtigung erfolgt durch den Shop und wird innerhalb des Shops konfiguriert.
| Kundenbenachtichtigung bei Abschluss der Bestellung | ja/nein | Soll der Kunden nach Abschluss der Bestellung, durch Warenversand, benachrichtigt werden. |
Versand
In der Schnittstellenkonfiguration kann optional eine Versandanweisung konfiguriert werden. Es wird ein versicherter und unversicherter Versand, sowie Stückgutversand und Abholung unterstüzt. Innerhalb der Konfiguration ist die dafür in Magento verwendete Versandart unter System -> Konfiguration -> Versandarten in dem Feld zu hinterlegen. Dadurch wird die entsprechende Versandanweisung an den Logistikdienstleister übergeben.
| Info |
|---|
Nur falls mehr als eine Versandart verwendet wird, sind angaben erforderlich. Standardmäßig wird immer als versichertes Paket versendet. |
| Warnung |
|---|
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> | Dies ist die Standardversandart. 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 |
|---|---|---|
| Zahlartenmethode Zahlart für NachnamesendungenNachname | <Zahlmethode><Bezeichnung> | Bezeichnung der Zahlart die zu einer Übergabe des Nachnamebetrags zum Geschäftspartner führt. Der Gesamtbetrag inkl. Steuern 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. |
| Warnung |
|---|
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 | |||
|---|---|---|---|---|---|
| Ignoriere Sendungsinformationsfehler | ja/nein | Ist diese Option aktiviert führt die fehlerhafte Übergabe von Sendungsdaten (Trackingnummer) nicht zu einem Abbruch mit Wiederholversuch. Die Übergabe von Sendungsdaten wird nicht mehr versucht. | |||
| 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 | Ignoriere Lagerbestandsfehler | ja/nein | Ist diese Option aktiviert führt die fehlerhafte Übergabe von Lagerbeständen nicht zu einem Abbruch mit Wiederholversuch. Die Übergabe von Lagerbeständen der betroffenen Artikel wird nicht widerholt, bis neue Bestandsmeldungen vorliegen. |
Verhalten der Schnittstelle
...
| Warnung |
|---|
Ein bereits übernommener Auftrag wird erneut übertragen, wenn im Shop der Status "Freigabe für Versand" wiederholt gesetzt wird. |
Aktivierte PDF Übernahme zum Auftrag, ohne obligatorisch erforderliche Einrichtung der Anpassung in Magento
...
wird |
...
. |
Fehler bei der Rückgabe von
...
Status, Sendungsdaten und Lagerbeständen
Abhängig von der Schnittstellenkonfiguration werden die Fehler ignoriert oder es wied Es wird versucht die Übertragung zu wiederholen, bis diese erfolgreich verläuft.
FAQ
Dokumentenübergabe
Dokumente können Übertragen werden, sofern diese in Magento zum Zeitpunkt der Bestellübernahme als PDF bereitgestellt sind und über die API zugänglich wären. Das ist standardmäßig nicht der Fall. Es existieren projektspezifische Erweiterungen die diese Funktionalität bereitstellen. Das ist im Einzelfall abzustimmen und zu implementieren.
Chargen- und Seriennummernrückgabe
Es existieren projektspezifische Anpassungen, die eine Rückgabe von Chargen und Seriennummern realisieren. Bei Bedarf sprechen sie uns bitte an.
Dropshippingartikel
Artikel die nicht über die Logistiksschnittstelle laufen, ist ein anderer Artikeltyp zuzuweisen. Wird dieser Artikeltyp von der Übernahme ausgenommen, erfolgt keine Übernahme dieser Auftragspositionen.
Teillieferungen
Teillieferungen werden durch die Schnittstelle nicht unterstützt.
Auftragssplitting
...
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.
| Code (carrier_code) | Frachtführer |
|---|---|
| dhl | DHL (DE) |
| dhl_paket | 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 |