Inhalt:

Allgemeines

In diesem Dokument ist die Shopware 6 Schnittstelle näher beschrieben. Bei Fragen können sie sich gerne an unseren Support wenden. Die Kontaktdetails sind auf der Seite Logistikschnittstellen zu entnehmen.

Nachfolgend erhalten sie wichtige Informationen zur Shopware Schnittstelle. 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 und Versandinformationen aus dem Logistiksystem.

Leistungsumfang

Implementierte Funktionen

Die Module Auftragsübernahme, Statusrückgabe inkl. Track&Trace sowie die Lagerbestandspflege sind implementiert.

Unterstützte Versionen

Shopware ab Version 6.4.0 wird unterstützt. Die Shopware Version 5.x wird über eine eigene Schnittstelle unterstützt.

Technische Anbindung

Die Shopware-Anbindung  ist über die Shopware API realisiert.

Voraussetzungen

Zur Anbindung benötigen wir die Shop URL, die Client ID und den zugehörigen Client Secret.

Außerdem benötigen wir eine Vorgabe 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".

Optionale PDF Belegübergabe

Optional können die zum Auftrag existierenden PDF Belege übernommen werden.

Konfigurationsoptionen der Schnittstelle

Verbindung / Zugangsdaten / Verbindungsparameter

OptionMögliche WerteBemerkung
Shopware URLURLDie Adresse ihres Shopware Shops im Format http://mein-shopware6shop.com oder falls ein gültiges Zertifikat installiert wurde alternativ auch mit https://mein-shopware6shop.com.
Client IDIDIhr Client-Secret für den API Zugriff.
Client SecretSecretIhre Client-ID für den API Zugriff.
Wartezeit0-65535Wartezeit 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-/Lesewartezeit0-65535Wartezeit 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 der Bestellungen

OptionMögliche WerteBemerkung
Freigabe zum Versand

Auftragsstatus: "offen"

Zahlstatus: "bezahlt"

Die vorstehenden Angaben sind die Standardwerte der Schnittstelle, bitte anpassen falls abweichend.

Es sind alle in Shopware zulässigen Statuswerte, die in der Standardinstallation verfügbar sind (Shopware Core).

Bestellung ist übertragenAuftragsstatus: "In Bearbeitung"

Die vorstehenden Angaben sind die Standardwerte der Schnittstelle, bitte anpassen falls abweichend.

Der Zahlstatus wird nicht mehr ausgewertet oder verändert.

Bestellung ist abgeschlossenAuftragsstatus: "Abgeschlossen"

Die vorstehenden Angaben sind die Standardwerte der Schnittstelle, bitte anpassen falls abweichend.

Der Zahlstatus wird nicht mehr ausgewertet oder verändert.

Kundendaten

OptionMögliche WerteBemerkung
Kundennummer<alles>Ihre Kundennummer im Zielsystem.

Versand

Nur falls mehr als eine Versandart verwendet wird, sind angaben erforderlich. Standardmäßig wird immer als versichertes Paket versendet.


OptionMögliche WerteBemerkung
Abholung ab Lager<Name der Versandart(en)>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<Name der Versandart(en)>

Dies ist die Standardversandart. Die Information wird aus dem Feld "Name" entnommen.

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<Name der Versandart(en)>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<Name der Versandart(en)>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.
Gesperrte Versandarten<Name der Versandart(en)>Die hier angegebenen Versandarten sind gesperrt. Eine Übernahme in die Logistik findet für Aufträge mit diesen Versandarten nicht statt.
Interner Warenverkehr<Name der Versandart(en)>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.

Dokumente

OptionMögliche WerteBemerkung
Auf PDF Dokumente warten und Auftrag erst dann übernehmenja/neinBelege werden erst übernommen, nachdem alle zu übernehmenden PDF-Dokumente zum Beleg vorhanden sind. Ist diese Option deaktiviert, wird der Auftrag mit den Belegen übernommen die zum Zeitpunkt der Übernahmefreigabe vorhanden sind.
Lieferschein übertragenja/neinEine in Shopware erstellter Lieferschein soll übertragen werden. Ist die Option "Auf PDF Dokumente warten und Auftrag erst dann übernehmen" mit "nein" belegt, hat diese Option keine Funktion.
Rechnung übertragenja/neinEine in Shopware erstellte Rechnung soll übertragen werden. Ist die Option "Auf PDF Dokumente warten und Auftrag erst dann übernehmen" mit "nein" belegt, hat diese Option keine Funktion.

Optionen

OptionMögliche WerteBemerkung
DHL Packstationsadresse aufbereitenja/neinBei aktivierter Option wird die Lieferadresse nach vorgaben der DHL für Packstationen formatiert, sofern die Lieferung an eine Packstation erfolgt.

Sonderfunktionen

OptionMögliche WerteBemerkung
Limitierung VerkaufskanäleSales Channel IDHier können die Verkaufskanäle in der Schnittstelle eingegrenzt werden. Der Aufbau ist '<Verkaufskanal ID>|<Kommentar>'. Alle Aufträge die nicht über die hier freigegebenen Verkaufskanäle eingegangen sind, werden nicht übernommen. Ist die Liste leer, werden alle Auftrage ungeachtet des Verkaufskanals übernommen.


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 zum Versand" wird dieser von der Schnittstelle übernommen. Nach der erfolgreichen Übernahme wird der Status "Bestellung ist übertragen" gesetzt.

Ein bereits übernommener Auftrag wird erneut übertragen, wenn im Shop der Status "Freigabe zum Versand" wiederholt gesetzt wird.

Aktivierte PDF Übernahme zum Auftrag, ohne die Erstellung der benötigten PDF Dokumente im Shop

In diesem Fall, wird der Auftrag nicht übernommen, solange die PDF Dokumente zum Auftrag nicht angelegt sind.

Mehrere Lieferadressen im Auftrag

Befinden sich mehrere Lieferadressen im Auftrag wird die erste im Auftrag hinterlegte Lieferadresse verwendet. Alle weiteren Lieferadressen werden ignoriert.

FAQ

Welche Rechte sind im Shop für den API Benutzer zu hinterlegen?

API-EndpunktRechte
URLRessourceerstellenlesenaktualisierenlöschenBemerkungen

search/state-machine-state

state-machine

-

X

-

-

Bestellstatus

X = erteilt / - = nicht erforderlich

search/product

product

-

X

-

-

Produktsuche

search/order

order

-

X

-

-

Bestellsuche

order

order

-

X

X

-

Bestellabruf

order-address

order-address

-

X

-

-

Adressen zu Bestellung

product


-

X

-

-

Produktabruf

_action/sync


-

X

X

-

Lagerbestandsupdate

_action/document/

document

-

X

-

-

Dokumentenabruf

_action/order/{id}/state/{transition}

order

X

X

-

-

Auftragsstatuswechsel

_action/order_delivery/{id}/state/{transition}

order

X

X

-

-

Versanddaten

Was passiert wenn ein übertragener Auftrag vor Auslieferung in Shopware bereits gelöscht wurde?

Schlägt das zurückgeben von Statusinformationen oder Sendungsdaten fehl, weil z. B. der Auftrag nicht mehr in Shopware gefunden wird, wird der Auftrag mit Fehlerkennzeichen in der Schnittstelle geschlossen. Es wird nicht mehr Versucht den Status zu übermitteln.