Shopware Connector

Dokumentation zum Shopware Connector und seinen Ressourcen.

Short Facts

  • Verbindet Shopware-Shop-Installationen mit der eCommerce Suite.
  • Importieren Sie die Shopware-Daten in die eCommerce Suite und nutzen Sie hier den vollen Funktionsumfang für Ihre Business-Prozesse.
  • Exportieren Sie Ihre Produktdaten und Statusänderungen aus der eCommerce Suite zurück in Ihren Shopware-Shop.
  • Multi-Mandantenfähig. Verbinden Sie die eCommerce Suite mit meheren Shopware-Shops und verwalten Sie die Shop-Daten zentral in einem Backend.
  • Flexible erweiterbar. Erweitern Sie bei Bedarf den eCommerce Suite Connector um weitere Shopware Resourcen.

Produkte & Kategorien

  • Pflegen Sie Ihre Produkte und Kategorien in der eCommerce Suite und exportieren Sie diese in Ihren Shopware-Shop.
  • Initialer Import der Produkte und Kategorien aus dem Shopware-Shop.
  • Export der vollen Produkt- und Kategorie-Daten aus der der eCommerce Suite in den Shopware-Shop.
  • Direkte Updates von Preis-Änderungen und Lägerbestanden.

Kunden

  • Import von Neukunden aus den Shopware-Shop in die eCommerce Suite.
  • Update des Kunden beim Auftrag-Import aus dem Shopware-Shop.

Aufträge

  • Import von neuen Aufträgen aus den Shopware-Shop in die eCommerce Suite.
  • Status-Update in der eCommerce Suite, sobald der Auftrag im Shopware-Shop als Bezahlt markiert wurde.
  • Export von Statusänderungen in der eCommerce Suite in den Shopware-Shop.

 

Installation

Die Installation lässt sich einfach über das Backend des eCMS unter Administration > eCMS Plugins durchführen.

 

Konfiguration & Setup

Für den Betrieb des Connectors benötigen Sie in Ihrem Shopware-Shop nur einen Benutzer mit API-Zugang. Am besten legen Sie einen neuen Benutzer (z.B. "ecs-connector") für den Connector an. Alle weiteren Konfigurationen nehmen Sie im eCommerce Suite Backend in der Remote-Connector-Verwaltung unter Extra > Remote-Connector vor.

In der Connector-Verwaltung finden Sie Kopiervorlagen für einen Shopware 4 und Shopware 5 Shop. Wählen Sie die für Ihren Shop passende Kopiervorlage aus und erstellen Sie eine Kopie über die Listen-Aktionen (Button "Aktion auswählen"). Nachdem eine Kopie erstellt wurde, rufen Sie diese zum Bearbeiten auf.

Ändern Sie in der Kopie das System-Label und die Bezeichnung für Ihren Shopware-Shop.

Connector Parameter

Um den Connector den Zugriff auf Ihren Shopware-Shop ermöglichen, ändern Sie die Parameter " api_url", " api_username" und " api_key". In dem " api_url" Parameter tragen Sie die vollständige URL der REST-API Ihres Shopware-Shops ein. In den " api_username" Parameter tragen Sie den Benutzernamen des Shopware-Benutzers mit API-Zugang ein. Und in den " api_key" Parameter tragen Sie API-Schlüssel des Shopware-Benutzers ein.

Wenn Sie in Ihrem Shopware-Shop mehr Kundengruppen als nur die "Shopkunden" Standardgruppe verwendet wird, müssen Sie im Parameter " mapping_customergroup" die Shopware-Kundengruppen ( s_core_customergroups.id) auf die eCommerce Suite Kundengruppen ( eos_person_group.grpid) mappen.

Kontrollieren Sie, ob im Paramter " mapping_payment" alle Zahlungsarten Ihres Shopware-Shops ( s_core_paymentmeans.name) auf eCommerce Suite Zahlungsarten ( ecs_payment_service.pys_method) gemappt sind.

Über den Parameter " mapping_shipping" werden die Versandarten der beiden System verlinkt. Wenn Sie mehr als nur den Standard-Versand anbeiten, müssten Sie die Konfiguration erweitern. Mappen Sie die Shopware-Versandkosten ( s_premium_dispatch.id) gegen die eCommerce Suite Versandarten ( eos_shipping_types.st_label).

Über den Parameter " mapping_orderstate" werden die Auftragsstatus verknüpft. Hier müssen Sie nur die Status berücksichtigen, die aus der eCommerce Suite an Shopware zurück gemeldet werden sollen. Sie haben also die Möglichkeit, in der eCommerce Suite Auftragsstatus für die Bearbeitung zu nutzen, die nicht in den Shopware-Shop meldet werden. Für die Status die an Shopware zurückgemeldet werden sollen, tragen Sie den Shopware-Auftragsstatus ( s_core_states.id) auf den eCommerce Suite Auftragsstatus ( eos_states.st_code) ein.

Wenn Sie bei Ihren Varianten-Produkten mehr als nur die Konfiguration-Gruppe "Farbe" nutzen, müssen Sie im Parameter " mapping_configgroup" die Konfiguration-Gruppen ( s_article_configurator_groups.id) auf die Varianten-Optionfelder bei den eCommerce Suite Produkten mappen.

Über den Parameter " mapping_packunit" können Sie die Shopware-Maßeinheiten ( s_core_units.id) auf die Verpackungsinhalt-Einheit der eCommerce Suite Produkte mappen.

Über den Parameter " mapping_country" mappen Sie die Shopware-Länder ( s_core_countries.id) aus die eCommerce Suite Länder ( ecs_country.cy_iso).

Connector aktivieren

Wenn Sie die Konfiguration des Connectors vervollständigt haben, können Sie diesen aktivieren (Status "enabled") und das Zeit-Interval festlegen, in dem der Connector ausgeführt werden soll. Empfohlen wird ein Zeit-Interval "in Minuten" mit einer Wiederholung in jeder Minute "1".

Nachdem Sie den Connector konfiguriert und aktiviert haben, können Sie über die Connector-Ressourcen festlegen, welche Daten ausgetauscht (Import/Export) werden sollen und in welchen Intervallen.

Kategorien

Für die Kategorien steht eine Import- und Export-Ressource zur Verfügung.

Über die Import-Ressource (Adaptor ecs_remoteconnector_resource_shopware_categories_pull) werden die Kategorien aus Ihren Shopware-Shop in den Kategorienbaum des eCommerce Suite Shops importiert. Sie können diesen Import nutzen, um die Kategorien Ihres Shopware-Shops einmalig in die eCommerce Suite importieren und danach die Kategorien in der eCommerce Suite zu pflegen und alle Änderungen in den Shopware-Shop zu exportieren. Wählen Sie für dieses Vorgehen ein "einmalig" Zeit-Interval aus und aktivieren Sie die Ressource (Status "enabled"). Nach erfolgreichen Import wird die Ressource automatisch deaktiviert.

Sie können die Import-Ressource auch nutzen, um dauerhaft die Shopware-Kategorien in die eCommerce Suite zu importieren. In diesem Fall werden die Kategorien weiterhin im Shopware-Backend gepflegt und nur in den eCommerce Suite gespiegelt. Für dieses Vorgehen, wählen Sie ein wiederkehrendes Zeit-Interval (z.B. "täglich") aus.

In der Import-Ressource können Sie einstellen, ab welcher Unterkategorie (" shopware_parent_id") die Kategorien  importiert werden sollen. Standardmässig ist dies auf die "Deutsch" Unterkategorie ( s_categories.id 3) einstellt.

Über die Export-Ressource (Adaptor ecs_remoteconnector_resource_shopware_categories_push) können die Kategorien aus dem eCommerce Suite Shop in den Shopware-Shop exportiert werden. Diese Ressource sollten Sie nur aktivieren, wenn Sie die Shop-Kateogiren in der eCommerce Suite pflegen und aus dieser an Shopware übertragen.

In der Export-Ressource können Sie wie in der Import-Ressource die Shopware-Unterkategorie (" shopware_parent_id") einstellen, unter der die eCommerce Suite Kategorien eingefügt werden sollen. Standardmässig ist dies auf die "Deutsch" Unterkategorie ( s_categories.id 3) einstellt.

Produkte

Für die Produkte steht eine Import- und Export-Ressource zur Verfügung.

Mit der Import-Ressource (Adaptor ecs_remoteconnector_resource_shopware_articles_pull) können Sie die Shopware-Artikel in den eCommerce Suite Shop importieren. Den Import können Sie verwenden, um alle Produkte einmalig zu importieren und danach die Produkte in der eCommerce Suite zu pflegen und alle Änderungen in den Shopware-Shop zu exportieren. Für dieses Vorgehen, stellen die Ressource auf ein "einmalig" Zeit-Intervall ein und aktivieren sie (Status "enabled"). Nach dem Import aller Shopware-Artikel wird die Ressource wieder deaktiviert.

Wenn Sie Ihre Artikel weiterhin in Shopware pflegen möchten und diese nur in die eCommerce Suite spiegeln möchten, aktivieren die Import-Ressource mit einem wiederkehrendes Zeit-Interval (z.B. "täglich").

Über die Export-Ressource (Adaptor ecs_remoteconnector_resource_shopware_articles_push) können Sie die eCommerce Suite Produkte in den Shopware-Shop einspielen. Nutzen Sie diese Ressource, wenn Sie Ihre Produkte in der eCommerce Suite pflegen möchten und von dort in den Shopware-Shop exportieren möchten.

Im Produkt-Export werden folgende Shopware-Features unterstützt:

  • Varianten-Produkte
  • Preisgruppen
  • Kategorie-Verknüpfungen
  • Produkt-Bilder mit Varianten-Verknüpfungen
  • Download-Dokumente
  • Zubehör-Produkte

Für Produkte gibt es eine extra Export-Ressource (Adaptor ecs_remoteconnector_resource_shopware_articles_push_pricestockstate) für Produkt-Preise und Lagerbestände. In diesem Export werden nur Produkte mit Updates seit der letzten Ausführung berücksichtigt, um die Datenmenge klein zu halten. So kann die Ressource häufg ausgeführt werden und Änderungen bei den Preise und Lagerbestände können direkt in den Shopware-Shop exportiert werden. 

In den Produkt-Import/Export kann mit dem Parameter " inStock_unlimited" der Shopware-Wert für unendlichen Lagerbestand aus der eCommerce Suite eingestellt werden.

Im Export kann mit dem Parameter " pseudoSales_factor" ein Faktor für den eCommerce Suite Offer-Level einstellt. Mit den Faktor und dem Offer-Level wird die Shopware-Pseudo-Verkäufe berechnet (offer-level * factor).

Mit den Parameter " pack_size_divider", " pack_size_pos_width", " pack_size_pos_length" und " pack_size_pos_height" kann das eCommerce Suite Feld "Abmessungen" auf die Shopware-Felder "Breite", "Höhe" und "Länge" gemappt werden.

Kunden

Über die Import-Ressource (Adaptor ecs_remoteconnector_resource_shopware_customers_pull) können Neukunden aus dem Shopware-Shop in die eCommerce Suite importiert werden. Standardmäßig überprüft die Ressource alle Shopware-Neukunden ( s_user.firstLogin) der letzten drei Tage, seit der letzten Ausführung der Ressource.

Bei den eCommerce Suite Kunden wird in der Externe Kunden-Nr die Shopware-Kundennummer ( s_user_billingaddress.customernumber) mit dem Preset "Shopware--" gespeichert.

Aufträge

Für die Aufträge steht eine Import-Ressource zur Verfügung.

Über die Import-Ressource (Adaptor ecs_remoteconnector_resource_shopware_orders_pull) können neue Aufträge aus dem Shopware-Shop in die eCommerce Suite importiert werden. Weiter fragt die Ressource bezahlte Aufträge aus Shopware ab und prüft ob diese Aufträge in der eCommerce Suite bereits im Bezahlt-Auftragsstatus waren. Wird ein neu bezahlter Auftrag erkannt, wird dieser in der eCommerce Suite einmalig in den Bezahlt-Auftragsstatus gesetzt.

Bei den eCommerce Suite Aufträgen wird in der Externe Auftrags-Nr. die Shopware-Auftragsnummer ( s_order.ordernumber) mit dem Preset "Shopware--" gespeichert.

In der Import-Ressource können für die Shopware-Aufträge verschiedene Auftragsstatus konfiguriert werden. Über den Parameter " order_state_default" kann der Start-Status für den Import festgelegt werden. Bleibt ein Auftrag in diesem Status stehen, ist im Import ein Fehler aufgetreten. Über den Parameter " order_state_create_success" kann der Status festgelegt werden, wenn der Shopware-Auftrag erfolgreich importiert wurde. Mit dem Parameter " order_state_create_error" kann der Status für einen fehlgeschlagenen Import festgelegt werden. Mit dem Parameter " order_state_paid_success" kann der Status für einen bezahlten Shopware-Auftrag festgelegt werden. Der Parameter " order_state_paid_error" legt den Status für einen Zahlungsfehler fest.

Mit den Parameter " pos_name" kann der Point-of-Sale für die Shopware-Aufträge festgelegt werden. Über den Parameter " pos_name_extend" kann festgelegt werden, dass der Point-of-Sale mit dem Shopware-Shop-Name erweitert wird.

Mit den Parametern " xcost_shipping_pcode", " xcost_shipping_name" und " xcost_shipping_block" kann die Versandkosten-Auftragsposition konfiguriert werden.

Mit den Parameter " taxident_status" kann der Import-Status von USt-ID-Nummern festgelegt werden. Mit " third_country_export" kann der Import-Status für USt freie Ausfuhrlieferungen.

Die Statusänderungen bei eCommerce Suite Aufträgen können über die Export-Ressource (Adaptor ecs_remoteconnector_resource_shopware_orders_push) in den Shopware-Auftrag übertragen werden.