Wir empfehlen Ihnen, die Installation des IntoSymbioConnector-Plugins zuerst auf einer Shopware-Testumgebung durchzuführen. Die Testumgebung sollte entsprechend ihrem Live-Shop konfiguriert sein. So können Sie in aller Ruhe die Funktionalität und Bestellungen ausprobieren.
So gehen Sie vor:
Das Plugin wird über die Shopware-Admin (Erweiterungen -> Meine Erweiterungen) installiert.
Über die Funktion "Erweiterung hochladen" laden Sie die gelieferte zip-Datei hoch.
Anschliessend installieren und aktivieren Sie das Plugin.
| Note |
|---|
Sollte auf der Konfigurationsseite die Schaltfläche «API Verbindung testen» nicht sichtbar sein, tun sie folgendes: Wechseln Sie auf die Serverkonsole des Hostingservers und führen Sie das Kommando aus ~/html$ bin/build-administration.sh Damit wird die Administration neu gebaut und die neuen Frontendkomponenten werden nun angezeigt. |
Nach der erfolgreichen Installation können Sie mit der Konfiguration beginnen. In zwei Schritten nehmen Sie folgende Einstellungen vor (alle Felder sind obligatorisch):
Zugangsdaten für das Symbio-API
Symbio-API URL: Die URL für das produktive SYMBIOCOMMERCE-System (oder das Staging System) haben Sie von Symbionet erhalten.
Client-id: Den Namen des Clients haben Sie von Symbionet erhalten.
Username: Ein gültiger Nutzer des SYMBIOCOMMERCE-Accounts des Shopbetreibers.
Legen Sie auf SYMBIOCOMMERCE in der Nutzerverwaltung Ihres Geschäftskontos einen neuen, separaten Nutzer an, der nur im Zusammenhang mit dem SYMBIO Connector verwendet wird. Weisen Sie dem Nutzer die Administratorrechte zu. So verhindern Sie, dass das Passwort ungewollt verändert wird und dadurch dann die Verbindung zu SYMBIOCOMMERCE fehlschlägt.
Weisen Sie dem Nutzer die Administratorrechte zu.
Client-Secret: Das Client-Secret des Clients haben Sie von Symbionet erhalten.
Die id Id des Sales-Group-Channels: Für den SYMBIO Shop tragen Sie “3” ein. Ab Version 5.3.2 ist dieser Parameter nicht mehr nötig.
Land (ISO-2): Der zweistellige ISO-Code des Landes, in dem Sie den Katalog die Verkaufsgruppe anbieten wollen.
Währung (ISO-3): Der dreistellige ISO-Code der Währung, die Sie für den Katalog die Verkaufsgruppe nutzen.
| Info |
|---|
Ihre Zugangsdaten für das SYMBIOCOMMERCE-API haben Sie von SYMBIONET erhalten. Wenn dies Falls nicht passiert ist, wenden Sie sich bitte an den Support. |
Symbio-Konfiguration:
Hauptkategorie für Symbio-Kategoriebaum: Wählen Sie eine Kategorie aus der Auswahlliste. Welche genau, hängt vom Setup Ihres Shops bzw. der verwendeten Verkaufskanäle ab. Medien-Ordner für
In der PlugInConfig treffen Sie auch eine Auswahl, welche bestehende Kategorie als Root dienen soll. Beim Aufruf der Kategorien über den Endpunkt
/services/product/api/external/v1/categorieswird die ganze Struktur aus SYMBIOCOMMERCE geliefert. In der Select-Box können Sie die entsprechende Kategorie auswählen.Medien-Ordner für Produktbilder: Wählen Sie einen Medienordner aus, in dem die aus SYMBIOCOMMERCE importierten Produktbilder abgelegt werden.
Produkt-Sichtbarkeit - Sales-Channel: Wählen Sie einen Verkaufskanal aus, dem die SYMBIOCOMMERCE-Produkte zugeordnet werden.
Standard-Steuersatz: Wählen Sie für Ihre Produkte den gesetzlichen Steuersatz aus. Dieser wird den Produkten beim Import zugeordnet.
Liste der Bestell- und Zahlungsstatuscodes zur Übertragung: Wählen Sie einen oder mehrere Statuscodes aus, bei deren Auftreten die Übertragung einer Bestellung zu SYMBIOCOMMERCE ausgelöst wird. Einige Statuscodes sind mehrfach vorhanden, stehen aber nicht für dasselbe. Wählen Sie am besten alle von diesen aus
ERP Wert - Versandkosten:
In spezifischen Fällen können Sie dieses Feld benutzen, um einen Wert für die Versandkosten einzutragen.Über die SYMPIOCOMMERCE Bestell-API wird der Wert beim Auslesen der Bestellung mitgeliefert, um ins ERP-System übertragen zu werden.
Bestellexport
Datum, ab wann die Bestellungen übertragen werden sollen.
Verzögerung der Bestellübertragung
Kategorien
In der PlugInConfig treffen Sie auch eine Auswahl, welche bestehende Category als Root dienen soll. Beim Aufruf der Kategorien über den Endpunkt /services/product/api/external/v1/categories wird die ganze Struktur aus SYMBIOCOMMERCE geliefert. In der SelectBox können Sie dann die entsprechende Kategorie auswählen.
in Minuten erfassen
Produkt-Synchronisation
Preise überschreiben: Wenn die Produkt-Synchronisation von SYMBIOCOMMERCE auf Shopware durchgeführt wird und der Radio-Button aktiviert ist, werden die Preise im Shop überschrieben.
Medien aktualisieren: Bei der Produkt-Synchronisation werden die Medien (Bilder, Videos, PDFs) auf den aktuellen Stand der Daten von SYMBIOCOMMERCE im Shop gesetzt. Dabei können in Shopware hinzugefügte Medien überschrieben werden, falls es Differenzen zu SYMBIOCOMMERCE Medien gibt.
Storefront Einstellungen
Verfügbarkeiten überprüfen: Ist diese Funktion aktiv, wird beim Hinzufügen eines Artikels in den Warenkorb seine Verfügbarkeit überprüft. So können jene Artikel, die in der Zwischenzeit nicht mehr verfügbar sind, nicht in den Warenkorb gelegt werden.
Download-Tab anzeigen: Ist der Radio-Button aktiv und sind dem Produkt/Artikel PDF-Dateien zugewiesen, werden die PDF-Dateien in der Detailübersicht des Produkts unter dem Reiter “Downloads” angezeigt. Sie können mittels Klick heruntergeladen werden.
Eine aus SYMBIOCOMMERCE übernommene Kategorie erkennen Sie in der Administration an den in der Karte Symbio-Daten angezeigten Feldern.
In der Karte Symbio-Daten finden sie die Felder:
Symbio-CategoryId finden Sie die zugehörige CategoryId aus SYMBIOCOMMERCE.
Erzeugt zeigt den Zeitstempel der ersten Übertragung.
Aktualisiert zeigt den Zeitstempel der letzten Aktualisierung.
Prüfsumme enthält die Prüfsumme der zuletzt an SYMBIOCOMMERCE übermittelten Daten.
Einen aus SYMBIOCOMMERCE übernommenen Artikel (in Shopware als Produkt bezeichnet) erkennen Sie in der Administration an den in der Karte Symbio-Daten angezeigten Feldern und dienen der Identifikation der Produkte und Varianten.
In der Karte Symbio-Daten finden Sie die Felder:
SymbioProductId zeigt die ProductId aus SYMBIOCOMMERCE - ist bei Varianten leer.
SymbioArticleId zeigt die ArticleId aus SYMBIOCOMMERCE - ist bei Produkten leer.
SymbioArticleSKU zeigt die SKU des Artikels aus SYMBIOCOMMERCE - ist bei Produkten leer.
Handelt es sich um ein Einzelprodukt (d.h. das Produkt hat keine Varianten), sind alle diese drei Felder gefüllt. Wenn es sich um die Kopfdarstellung eines Variantenprodukts handelt, ist nur das Feld SymbioProductId gefüllt.
Handelt es sich um eine Produktvariante, sind dagegen nur die Felder SymbioArticleId und SymbioArticleSKU gefüllt.
Erzeugt zeigt den Zeitstempel der ersten Übertragung.
Aktualisiert zeigt den Zeitstempel der letzten Aktualisierung.
Prüfsumme enthält die Prüfsumme der zuletzt an SYMBIOCOMMERCE übermittelten Daten.
Eine aus SYMBIOCOMMERCE übernommene Kategorie erkennen Sie in der Administration an den in der Karte Symbio-Daten angezeigten Feldern.
In der Karte Symbio-Daten finden Sie sie die Felder:
SymbioMediaId identifiziert die Produktabbildung in Symbio-CategoryId finden Sie die zugehörige CategoryId aus SYMBIOCOMMERCE.
Erzeugt zeigt den Zeitstempel der ersten Übertragung.
Aktualisiert zeigt den Zeitstempel der letzten Aktualisierung.
Prüfsumme enthält die Prüfsumme der zuletzt an SYMBIOCOMMERCE übermittelten Daten.
Auf SYMBIO Commerce hinzugefügte Artikel werden in Shopware hinzugefügt. Das Produkt bleibt aktiviert.
Einen aus SYMBIOCOMMERCE übernommenen Artikel (in Shopware als Produkt bezeichnet) erkennen Sie in der Administration an den in der Karte Symbio-Daten angezeigten Feldern .Empfänger, die noch nicht in SYMBIOCOMMERCE existieren, werden vor einer Übertragung einer Bestellung mit Symbio-Artikeln angelegt. Eine Prüfung anhand der SymbioID stellt sicher, dass kein Empfänger doppelt angelegt wirdund dienen der Identifikation der Produkte und Varianten.
In der Karte Symbio-Daten finden Sie folgende die Felder:
SymbioRecipientId
identifiziert den Empfänger in SYMBIOCOMMERCE
SymbioRecipientIdentification
identifiziert den Kunden in SYMBIOCOMMERCE
Erzeugt
Zeitstempel der ersten Übertragung
Aktualisiert
Zeitstempel der letzten Aktualisierung
Prüfsumme
SymbioProductId zeigt die ProductId aus SYMBIOCOMMERCE - ist bei Varianten leer.
SymbioArticleId zeigt die ArticleId aus SYMBIOCOMMERCE - ist bei Produkten leer.
SymbioArticleSKU zeigt die SKU des Artikels aus SYMBIOCOMMERCE - ist bei Produkten leer.
Handelt es sich um ein Einzelprodukt (d.h. das Produkt hat keine Varianten), sind alle diese drei Felder gefüllt. Wenn es sich um die Kopfdarstellung eines Variantenprodukts handelt, ist nur das Feld SymbioProductId gefüllt.
Handelt es sich um eine Produktvariante, sind dagegen nur die Felder SymbioArticleId und SymbioArticleSKU gefüllt.
Erzeugt zeigt den Zeitstempel der ersten Übertragung.
Aktualisiert zeigt den Zeitstempel der letzten Aktualisierung.
Prüfsumme enthält die Prüfsumme der zuletzt an SYMBIOCOMMERCE übermittelten Daten.
GET https://{{Host}}/services/product/api/external/v1/selling-products/channels/{shop-channelId}
POST https://{{Host}}/services/product/api/external/v1/resource-planning/article-availability
POST https://{{Host}}/services/recipient/api/external/v1/addresses/
POST https://{{Host}}/services/recipient/api/external/v1/recipients
PUT https://{{Host}}/services/recipient/api/external/v1/recipients
POST https://{{Host}}/services/order/api/external/v2/order-placement/submit/channel/{channelId}/countryIso/{countryIso}
Daten, die nicht aus SYMBIOCOMMERCE importiert werden, werden nicht überschrieben.
Produkteimport läuft fehlerlos durch.
Es muss ausgewählt werden, ob der importierte CategoryBaum an eine beliebige, existierende Category gehängt wird oder die Symbio-Artikel einer bestehenden Kategorie zu gewiesen werden.
Die SYMBIOCOMMERCE-Category “Wurzel” oder “Root” wird beim Import ignoriert.
Zuordnungen von zuvor importierten Kategorien werden nicht überschrieben. (Status Quo)
In ExtensionConfig sollen in der SelectBox zur Auswahl nur Kategorien angezeigt werden, die nicht aus SYMBIOCOMMERCE importiert wurden.
Alle Mediendateien werden korrekt importiert angelegt und angezeigt.
Bestellungen mit SYMBIOCOMMERCE-Artikeln werden an erfolgreich an SYMBIOCOMMERCE übermittelt
Bestellungen ohne SYMBIOCOMMERCE-Artikel werden von Shopware erfolgreich bearbeitet. Keine Beinträchtigung von SYMBIO Connector.
Bestellungen ohne SYMIBOCOMMERCE-Artikel werden vom SYMBIO Connector nicht wiederholt verarbeitet.
Gemischte Bestellungen, die neben SYMBIOCOMMERCE-Artikeln auch Artikel von anderen Quellen enthalten, werden so verarbeitet, dass SYMBIOCOMMERCE-Artikel an SYMBIOCOMMERCE übertragen werden und die übrigen Artikel vom normalen Shopware-Prozess verarbeitet werden.
Empfänger von SYMBIOCOMMERCE-Bestellungen werden vor der Übertragung der Bestellung in SYMBIOCOMMERCE angelegt.
Empfänger von Bestellungen ohne SYMBIOCOMMERCE-Artikel werden nicht in SYMBIOCOMMERCE angelegt.
In der OrderDetailView wird in der Positionentabelle eine neue Spalte mit Spaltentitel “SYMBIO“ angezeigt.
In Shopware getätigte Bestellungen werden dem konfigurierten Intervall entsprechend (Scheduled Task) an SYMBIOCOMMERCE übertragen. Eine erfolgreich übertragene Bestellung erkennen Sie an den Feldern in der Karte Symbio-Daten.
| Note |
|---|
Nachträgliche Änderungen in einer Bestellung werden nicht übertragen. |
In der Karte Symbio-Daten finden Sie die Felder:
SymbioOrderId identifiziert die Bestellung im SYMBIOCOMMERCE.
SymbioOrderStatus zeigt den von SYMBIOCOMMERCE vergebenen Order-Status an. Dieser sollte in der Regel "APPROVED" sein, wird hier ein anderer Wert gezeigt, so sollte die ordnungsgemässe Verarbeitung der Bestellung in SYMBIOCOMMERCE überprüft werden.
SymbioZeitstempel gibt den Zeitpunkt der Übertragung an SYMBIOCOMMERCE an.
Button 'Auftrag zurücksetzen'
Falls eine Bestellung nicht erfolgreich übertragen wurde, haben Sie die Möglichkeit, die Übertragung zu zurückzusetzen, indem Sie auf den Button 'Auftrag zurücksetzen' klicken. Dadurch wird sichergestellt, dass die Bestellung beim nächsten Übertragungsintervall erneut übermittelt wird.
Im Falle, dass die Bestellung zwar in SYMBIOCOMMERCE erstellt wurde, jedoch die Rückmeldung an den SYMBIO Shop unterbrochen wurde, entsteht bei einer erneuten erfolgreichen Übertragung keine doppelte Bestellung.
Verarbeitung zusammengesetzter Bestellungen
Eine Bestellung bei Ihrem Shop kann Artikel aus SYMBIOCOMMERCE und anderen Quellen enthalten. Grundsätzlich weist SYMBIOCOMMERCE alle Bestellungen mit unbekannten Artikeln zurück. Deshalb müssen Sie in der Administration eine Separation einrichten.
In der OrderDetailView (Shopadministration) sehen Sie in der Übersicht der Bestellpositionen eine entsprechende Spalte, welche Artikel in der Bestellung aus SymbioCommecerce sind (erkennbar am “ok-Häkchen”-Icon).
Das Separieren kann mittels Lookup auf die into_symbio_connector_product_addons geschehen.
Verarbeitete Bestellungen werden in die into_symbio_connector_order_addons geschrieben.
Es gibt drei Möglichkeiten, wie die Bestellungen zusammengesetzt sein können:
Die Bestellung enthält nur Artikel aus SYMBIOCOMMERCE.
Alle Artikel werden nach SYMBIOCOMMERCE übertragen.
Bestellung wird mit den SymbioDaten in into_symbio_connector_order_addons eingetragen.
Die Bestellung enthält keine Artikel aus SYMBIOCOMMERCE.
Keine Artikel werden übertragen.
Für die Verarbeitung der Bestellung stehen Ihnen zwei Optionen zur Verfügung:Bestellung wird in into_symbio_connector_order_addons eingetragen und als verarbeitet markiert.
Sie markieren die Bestellung an einer anderen Stelle als verarbeitet.
Die Bestellung ist gemischt und enthält neben Artikeln aus SYMBIOCOMMERCE auch Artikel aus anderen Quellen.
SYMBIOCOMMERCE-Artikel werden übertragen
Bestellung wird mit den Daten aus SYMBIOCOMMERCE in into_symbio_connector_order_addons eingetragen.
Die Artikel, die nicht aus SYMBIOCOMMERCE stammen, werden nicht übertragen.
Bestellungen, die keine SYMBIOCOMMERCE-Artikel enthalten, müssen Sie als verarbeitet markieren, damit diese nicht bei jedem Übertragungszyklus erneut verarbeitet werden.
Zudem können Sie auch alle verarbeiteten Bestellungen in die into_symbio_connector_order_addons Tabelle eintragen. Dort können Sie dann vermerken, wie viele “Symbio Connector”-Artikel in dieser Bestellung vorhanden sind. Ist die Menge = 0 werden in der Administration weitere SymbioConnector spezifischen Prozesse verhindert
Import CSV-Versandmeldungen
Der Import der Versandmeldungen aus dem Kunden ERP erfolgt per CSV-Import. Dabei werden zu jeder Bestellung die übermittelten Trackingcodes und die zugehörigen Lieferpositionen und -mengen importiert. Der Bestellstatus wird entsprechend angepasst auf "teilweise ausgeliefert" bzw. "vollständig ausgeliefert". Die übermittelten Tracking-URLs werden in der Bestellung abgelegt und damit auch dem Kunden in seiner Bestellübersicht angezeigt.
Datentrennzeichen: ; (Semikolon)
Die zu verarbeitenden CSV-Dateien sind ohne Header und enthalten je Packstück eine Zeile mit den folgenden Feldern:
Beschreibung
Datentyp
Bemerkung
ERP-Auftragsnummer
int
ERP-Auftragsposition
int
Shop-Aufragsnummer
string
Shopware Bestellnummer
Shop-Auftragsposition
int
Position in der Shopware-Bestellung
Menge
int
Carrier
string
Handling Unit
string
Tracking-URL
string
Connector / SYMBIOCOMMERCE
GET https://{{Host}}/services/product/api/external/v1/categories
Die Produktabbildungen werden aus SYMBIOCOMMERCE ebenfalls automatisch zu Shopware übertragen.
Aktualisierung der Medien:
Auf SYMBIO Commerce gelöschte Producktbilder werden auf Shopware gelöscht.
Auf SYMBIO Commerce hinzugefügte Produktbilder werden auf Shopware hinzugefügt.
Auf SYMBIO Commerce hinzugefügte Artikelbilder werden auf Shopware übernommen.
Auf SYMBIO Commerce gelöschte Artikelbilder werden auf Shopware gelöscht.
Wird auf SYMBIO Commerce ein Bild mit einem anderen überschrieben, wird dies nicht übernommen, weil die Medien-Id gleich bleibt.
Auf Shopware gelöschte Bilder werden wieder neu angelegt.
Die Produktabbildungen sind an den Feldern in der Karte SYMBIO-Daten erkennbar.
In der Karte Symbio-Daten finden Sie die Felder:
SymbioMediaId identifiziert die Produktabbildung in SYMBIOCOMMERCE.
Erzeugt zeigt den Zeitstempel der ersten Übertragung.
Aktualisiert zeigt den Zeitstempel der letzten Aktualisierung.
Prüfsumme enthält die Prüfsumme der zuletzt an SYMBIOCOMMERCE übermittelten Daten.
Kundendaten und Adressen werden nach ihrer Erfassung oder Aktualisierung in Shopware an SYMBIOCOMMERCE übertragen. Eine erfolgreiche Übertragung erkennen Sie in der Administration an den in der Karte Symbio-Daten angezeigten Feldern.
Empfänger, die noch nicht in SYMBIOCOMMERCE existieren, werden vor einer Übertragung einer Bestellung mit Symbio-Artikeln angelegt. Eine Prüfung anhand der SymbioID stellt sicher, dass kein Empfänger doppelt angelegt wird.
In der Karte Symbio-Daten finden Sie folgende Felder:
SymbioRecipientId | identifiziert den Empfänger in SYMBIOCOMMERCE |
SymbioRecipientIdentification | identifiziert den Kunden in SYMBIOCOMMERCE |
Erzeugt | Zeitstempel der ersten Übertragung |
Aktualisiert | Zeitstempel der letzten Aktualisierung |
Prüfsumme | Prüfsumme der zuletzt an SYMBIOCOMMERCE übermittelten Daten |
In Shopware getätigte Bestellungen werden dem konfigurierten Intervall entsprechend (Scheduled Task) an SYMBIOCOMMERCE übertragen. Eine erfolgreich übertragene Bestellung erkennen Sie an den Feldern in der Karte Symbio-Daten.
| Note |
|---|
Nachträgliche Änderungen in einer Bestellung werden nicht übertragen. |
In der Karte Symbio-Daten finden Sie die Felder:
SymbioOrderId identifiziert die Bestellung im SYMBIOCOMMERCE.
SymbioOrderStatus zeigt den von SYMBIOCOMMERCE vergebenen Order-Status an. Dieser sollte in der Regel "APPROVED" sein, wird hier ein anderer Wert gezeigt, so sollte die ordnungsgemässe Verarbeitung der Bestellung in SYMBIOCOMMERCE überprüft werden.
SymbioZeitstempel gibt den Zeitpunkt der Übertragung an SYMBIOCOMMERCE an.
Button 'Auftrag zurücksetzen'
Falls eine Bestellung nicht erfolgreich übertragen wurde, haben Sie die Möglichkeit, die Übertragung zu zurückzusetzen, indem Sie auf den Button 'Auftrag zurücksetzen' klicken. Dadurch wird sichergestellt, dass die Bestellung beim nächsten Übertragungsintervall erneut übermittelt wird.
Im Falle, dass die Bestellung zwar in SYMBIOCOMMERCE erstellt wurde, jedoch die Rückmeldung an den SYMBIO Shop unterbrochen wurde, entsteht bei einer erneuten erfolgreichen Übertragung keine doppelte Bestellung.
Verarbeitung zusammengesetzter Bestellungen
Eine Bestellung bei Ihrem Shop kann Artikel aus SYMBIOCOMMERCE und anderen Quellen enthalten. Grundsätzlich weist SYMBIOCOMMERCE alle Bestellungen mit unbekannten Artikeln zurück. Deshalb ist in der Administration eine Separation eingerichtet.
In der OrderDetailView (Shopadministration) sehen Sie in der Übersicht der Bestellpositionen eine entsprechende Spalte, welche Artikel in der Bestellung aus SYMBIOCOMMERCE sind (erkennbar am “✅ -Häkchen”-Icon).
Es gibt drei Möglichkeiten, wie die Bestellungen zusammengesetzt sein können:
Die Bestellung enthält nur Artikel aus SYMBIOCOMMERCE.
Alle Artikel werden nach SYMBIOCOMMERCE übertragen.
Alle Artikel erhalten ein ✅.
In der Karte Symbio-Daten steht im Feld Symbio-Order-Status “APPROVED”
Die Bestellung enthält keine Artikel aus SYMBIOCOMMERCE.
Keine Artikel werden übertragen.
Die Artikel werden nicht markiert.
In der Karte Symbio-Daten steht im Feld Symbio-Order-Status “NO_SYMBIO_ORDER”
Die Bestellung ist gemischt und enthält neben Artikeln aus SYMBIOCOMMERCE auch Artikel aus anderen Quellen.
SYMBIOCOMMERCE-Artikel werden übertragen und erhalten ein ✅.
Die Artikel, die nicht aus SYMBIOCOMMERCE stammen, werden nicht übertragen und erhalten ein ❌ .
In der Karte Symbio-Daten steht im Feld Symbio-Order-Status “APPROVED”
