In diesem Artikel erfahren Sie alles über die Nutzung von Komfortkasse mit Shopware (Version 4 und 5).


Lesen Sie zuvor den Artikel Erste Schritte: Einrichtung und Verbindung zum Shop.


Einrichtung der Shopware-API

Für den Zugriff von Komfortkasse auf den Shopware Shop muss ein neuer Benutzer mit API-Zugang erstellt werden. Melden Sie sich dazu im Shopware Backend an. Öffnen Sie die Benutzerverwaltung und fügen Sie einen neuen Benutzer hinzu:

Sie können den Benutzer z.B. komfortkasse nennen. Aktivieren Sie den Benutzer mit der Checkbox Aktiviert. Aktivieren Sie auch die Checkbox bei API-Zugang, und kopieren Sie den API-Schlüssel. Geben Sie dem Benutzer ausreichende Rechte, z.B. indem Sie ihn in die Rolle local_admins hinzufügen:



Sie müssen eine E-Mail Adresse angeben, diese wird aber nicht weiter verwendet. Sie können daher jede beliebige E-Mail Adresse verwenden. Speichern Sie den neuen Benutzer.


Weitere Informationen zu benötigten Rechten

Wir empfehlen dringend die Verwendung einer Rolle mit allen Rechten wie z.B. local_admins. Wenn Sie eine eigene Benutzerrolle für den Komfortkasse-Benutzer verwenden, stellen Sie sicher dass folgende Rechte hinterlegt sind:

  • customer: read, detail
  • order: read, update

Wenn Sie auch das Bestandsupdate bei Stornierung verwenden, ist zusätzlich erforderlich:

  • article: read, save


Anschließend leeren Sie den Shop Cache (Einstellungen - Caches/Performance - Shop Cache leeren).



Hinterlegen Sie den Benutzernamen und den API-Schlüssel in den Shop-Einstellungen in Ihrem Komfortkasse Händlerbereich. Wählen Sie dazu den Shop im Menü Einstellungen - Shops. Klicken Sie im Bereich Einstellungen für API-Zugriff auf Einstellungen bearbeiten und tragen Sie dann die Daten ein:

Klicken Sie anschließend auf Einstellungen speichern.


Sobald die API-Zugangsdaten gespeichert sind, kann Komfortkasse weitere benötigte Einstellungen vom Shop auslesen, z.B. vorhandene Zahlungsmethoden, Subshops und Bestellstatus. Während die Daten ausgelesen werden, sehen Sie möglicherweise eine entsprechende Anzeige neben dem jeweiligen Feld:


API-Einstellungen

Wenn die Daten nicht vom Shop ausgelesen werden können, finden Sie weiter unten in diesem Artikel im Kapitel Fehlersuche einige mögliche Fehlerursachen.

Wenn die Daten erfolgreich ausgelesen wurden, werden statt der IDs die korrekten Bezeichnungen angezeigt:


Komfortkasse unterstützt die Zahlungsarten Vorkasse, Rechnung, und Nachnahme. Wenn Sie nicht alle drei Zahlungsarten in Ihrem Shop verwenden, klicken Sie bei der jeweiligen Zahlungsart auf deaktivieren bzw. aktivieren:


Wenn die gewünschten Zahlungsarten aktiviert wurden, klicken Sie nochmals auf Einstellungen bearbeiten. Sie können dann die Einstellungen zu Subshops, Zahlungsarten, und Status vornehmen.


Bei allen Einstellungen, bei denen Daten aus dem Shop verwendet, können mit der Schaltfläche Daten neu auslesen die Daten neu vom Shop ausgelesen werden (z.B. wenn eine neue Zahlungsart im Shop hinzugefügt wurde).


Subshops

Wenn keine Subshops verwendet werden (oder wenn alle vorhandenen Subshops in Komfortkasse verwendet werden sollen), dann muss hier keine Auswahl getroffen werden.

Ansonsten können hier die gewünschten Subshops ausgewählt werden:

Reine Sprachshops müssen nicht getrennt in Komfortkasse eingerichtet werden, da Komfortkasse die Sprache automatisch erkennt. Subshops müssen nur getrennt eingerichtet werden, wenn es sich tatsächlich um verschiedene Shops, mit z.B. eigenen Namen und Logos, handelt. Nähere Informationen dazu weiter unten im Kapitel Subshops.


Die folgenden Einstellungen werden exemplarisch am Beispiel Vorkasse beschrieben. Die Einstellungen für Rechnung und Nachnahme sind ähnlich, die Unterschiede zu Vorkasse werden am Ende beschrieben. Auch wenn Sie in Ihrem Online-Shop nur Zahlung auf Rechnung verwenden, sollten Sie die folgenden Beschreibungen lesen.


Zahlungsart-ID

Hier wird ausgewählt, welche Shopware-Zahlungsart in Komfortkasse für "Vorkasse" verwendet werden soll. Normalerweise ist dies die in Shopware standardmäßig vorhandene Zahlungsart "Vorkasse":


Bestellstatus und Zahlungsstatus für offene Bestellungen

Hier wird ausgewählt, welche Bestellungen Komfortkasse als "offen" erachtet und eine Zahlung dazu erwartet. Es kann entweder der Bestellstatus, der Zahlungsstatus, oder beide Status angegeben werden. (Wenn z.B. nur der Bestellstatus angegeben wird, wird der Zahlungsstatus ignoriert.)

Meist wird bei Vorkasse der Bestellstatus "Offen" und/oder der Zahlungsstatus "Offen" hinterlegt. Zusätzlich können noch weitere Status sinnvoll sein, z.B. "1./2./3. Mahnung":


Zahlungsstatus für teilweise bezahlte Bestellungen

Bestellungen, zu denen eine Teilzahlung eingeht, werden von Komfortkasse auf diesen Zahlungsstatus in Shopware gesetzt. (Es kann kein Bestellstatus gewählt werden):


Bestellstatus und Zahlungsstatus für bezahlte Bestellungen

Bestellungen, die in Komfortkasse komplett bezahlt wurden, werden von Komfortkasse auf diesen Status in Shopware gesetzt. Es kann ein Bestellstatus und/oder ein Zahlungsstatus gewählt werden. Wenn z.B. nur der Zahlungsstatus verändert werden soll, der Bestellstatus aber nicht verändert werden soll, wird beim Bestellstatus "nicht ändern" gewählt:


Bestellstatus und Zahlungsstatus für stornierte Bestellungen

Wenn eine Bestellung in Komfortkasse storniert wird (z.B. weil über einen längeren Zeitraum keine Zahlung eingegangen ist), wird dieser Status in Shopware gesetzt. Es kann ein Bestellstatus und/oder ein Zahlungsstatus gewählt werden. Wenn z.B. nur der Zahlungsstatus verändert werden soll, der Bestellstatus aber nicht verändert werden soll, wird beim Bestellstatus "nicht ändern" gewählt:

Bestellstatus und Zahlungsstatus für rückerstattete Bestellungen

Wenn zu einer Bestellung in Komfortkasse eine Rückerstattung durchgeführt wird, kann dieser Status in Shopware gesetzt werden. Es kann ein Bestellstatus und/oder ein Zahlungsstatus gewählt werden. Wenn z.B. nur der Zahlungsstatus verändert werden soll, der Bestellstatus aber nicht verändert werden soll, wird beim Bestellstatus "nicht ändern" gewählt:


Zahlungsstatus für Mahnstufe 1, 2, 3,...

Wenn Komfortkasse Mahnungen (Zahlungserinnerungen) zu einer Bestellung versendet, kann der Zahlungsstatus in Shopware gesetzt werden. Diese Einstellungen sind optional.


Zahlungsstatus für Inkasso

Wenn das integrierte Inkasso in Komfortkasse genutzt wird und eine Bestellung zum Inkasso übergeben wurde, wird folgender Zahlungsstatus in Shopware gesetzt.

(Ein Inkasso für Bestellungen mit Zahlungsart Vorkasse ist normalerweise nicht möglich, es gibt aber Ausnahmefälle, bei denen dies der Fall sein kann.)


Zahlungsweisen für Überwachung

Wenn die Überwachung von anderen Zahlungsarten genutzt wird (optional), werden hier die Zahlungsweisen ausgewählt, die überwacht werden sollen.

(Der Hinweis "Im Shop nicht mehr vorhanden" wird angezeigt, wenn eine Zahlungsweise oder ein Status zwar nicht mehr im Shop vorhanden ist, aber noch in Bestellungen in Komfortkasse vorhanden ist. Dies kann z.B. der Fall sein wenn ein Shop neu aufgesetzt wird.)


Einstellungen für Zahlung auf Rechnung 

Für Zahlung auf Rechnung stehen dieselben Einstellungen wie für Vorkasse zur Verfügung, mit einem Unterschied: Wenn zu einer Bestellung keine Zahlung eingeht, wird diese nicht storniert, sondern als überfällig markiert. Dies ist technisch gesehen derselbe Vorgang, löst aber in der Praxis meist andere Folge-Prozesse aus: Während eine Vorkasse-Bestellung ohne Zahlung einfach storniert werden kann, muss eine überfällige Bestellung mit Zahlung auf Rechnung meist manuell nachbearbeitet oder z.B. ans Inkasso weitergegeben werden.


Einstellungen für Nachnahme 

Für Nachname stehen dieselben Einstellungen wie für Rechnung zur Verfügung, mit folgenden Einschränkungen:

  • Mahnungen stehen nicht zur Verfügung
  • Inkasso steht nicht zur Verfügung


Einstellungen für Dokumente

Komfortkasse verarbeitet automatisch Dokumente wie Rechnungen und Gutschriften aus Shopware. Aus Rechnungen werden z.B. Rechnungsnummern übernommen. Wenn Gutschriften oder Stornorechnungen vorhanden sind, wird der Bestellbetrag entsprechend verringert.

Es können jeweils kommagetrennt Dokument-Typen aus Shopware hinterlegt werden. Der Dokument-Typ (Name) ist in Shopware in den Grundeinstellungen hinterlegt:

Folgende Einstellungen stehen zur Auswahl:

  • Dokumenttypen für Rechnungsnummern:
    Aus diesen Dokumenttypen werden Rechnungsnummern ausgelesen. Hier sollten die Namen der Dokumenttypen für Rechnungen und Gutschriften hinterlegt werden.
  • Dokumenttypen, die Bestellbetrag überschreiben:
    Aus diesen Dokumenttypen wird der Betrag ausgelesen und statt dem Betrag aus der Bestellung verwendet. Hier sollten die Namen der Dokumenttypen für Rechnungen hinterlegt werden. Wenn zu einer Bestellung z.B. nur ein Teil lieferbar ist und nur über diesen Teil eine Rechnung ausgestellt wird, wird der Rechnungsbetrag statt dem Bestellbetrag als offener Betrag in Komfortkasse übernommen.
  • Dokumenttypen, die Bestellbetrag verringern:
    Aus diesen Dokumenttypen wird der Betrag ausgelesen und vom Bestellbetrag (bzw. Rechnungsbetrag) in Abzug gebracht. Hier sollten die Namen der Dokumenttypen für Gutschriften und Stornorechnungen hinterlegt werden. Wenn bei einer Bestellung z.B. ein Teil der Ware zurückgesendet wird und darüber eine Gutschrift ausgestellt wird, wird der Gutschriftsbetrag in Komfortkasse vom Gesamtbetrag abgezogen.


Tracking Code einlesen

Wenn ja, wird der Tracking Code als Sendungsnummer (Lieferscheinnummer) in Komfortkasse übernommen. Dies ist z.B. bei der Verarbeitung von Nachnahme-Zahlungen sinnvoll.


Bei Stornierung Bestand korrigieren

Wenn in Shopware der Artikelbestand verwendet wird und der Bestand beim Erfassen einer Bestellung automatisch verringert wird, wird dieser Bestand beim Stornieren einer Vorkasse-Bestellung durch die Shopware API nicht wieder automatisch erhöht. Das kann durch diese Einstellung erreicht werden: wenn aktiv, wird der Bestand bei der Stornierung einer Vorkasse-Bestellung durch Komfortkasse automatisch in Shopware wieder erhöht.

Es wird durch den  API Aufruf PUT /articles/<Artikel-ID> das Attribut mainDetail.inStock um die entsprechende Menge erhöht.


Herstellen der Verbindung

Wenn alle Einstellungen zur API vollständig hinterlegt sind, kann der Shop mit Komfortkasse verbunden werden. Wählen Sie dazu im Aktionsmenü  die Aktion Verbindung herstellen.


Fehlersuche

Wenn die Verbindung nicht hergestellt werden kann, prüfen Sie ob die API korrekt funktioniert: 

Rufen Sie in Ihrem Web-Browser die Url http(s)://<ihr-shop>/api/orders auf. Geben Sie als Benutzernamen den Benutzernamen an, den Sie gerade erstellt haben, und als Passwort den API-Schlüssel. Wenn Sie nun eine Ausgabe sehen, funktioniert die Shopware API. Wenn Sie die Meldung Missing or invalid auth bekommen oder das Fenster zur Eingabe des Passworts wieder und wieder erscheint, funktioniert die API noch nicht richtig.


Prüfen Sie:

  • Wurde Benutzernamen und API-Schlüssel richtig eingegeben? Achten Sie auf Groß- und Kleinschreibung sowie auf Leerzeichen!
  • Wurde der Benutzer aktiviert? (Checkbox unter dem Benutzernamen)
  • Wurde der API-Zugang aktiviert? (Checkbox links neben dem API-Schlüssel)
  • Hat der Benutzer ausreichende Rechte? (Fügen Sie den Benutzer in die Rolle local_admins hinzu)
  • Wurde der Cache geleert?

Wenn der Zugriff weiterhin nicht funktioniert, finden Sie weitere Informationen möglicherweise im Shopware Log (Ordner /logs im Shopware-Verzeichnis) oder in den Logdateien Ihres Webservers.


Vorkasse in Shopware aktivieren

Um Komfortkasse nutzen zu können, müssen Sie Zahlung per Vorkasse in Shopware aktivieren. Wenn Sie bereits Vorkasse in Ihrem Shop anbieten, können Sie diesen Schritt überspringen. Bei einer Neuinstallation von Shopware ist Vorkasse normalerweise standardmäßig ebenfalls bereits aktiviert.


Melden Sie sich im Shopware Backend an und öffnen Sie Einstellungen - Zahlungsarten. Wählen Sie in der Liste "Vorkasse". (Wenn Vorkasse nicht vorhanden ist, wählen Sie "Neu" und fügen die folgenden Daten ein. In diesem Fall müssen Sie die korrekte Zahlungsart-ID, z.B. "5", im Komfortkasse Händlerbereich in den Shop-Einstellungen hinterlegen.)


Aktivieren Sie die Checkbox "Aktiv".


Sie haben nun Vorkasse in Ihrem Shop aktiviert.


Versand von Zahlungsinformationen in Shopware deaktivieren

Im Normalfall erhalten Ihre Kunden die Zahlungsinformationen direkt von Komfortkasse. Wenn Sie bereits Vorkasse anbieten, haben Sie Ihren Shop jetzt wahrscheinlich schon so konfiguriert, dass Ihre Kunden Ihre Bankverbindung erhalten. Diesen Versand müssen Sie nun deaktivieren. Hinweis: wenn Sie das Paket complete oder professional verwenden, können Sie auch weiterhin die Zahlungsinformationen selbst an Ihre Kunden senden. Wenden Sie sich an den Support, wenn Sie diese Option nutzen wollen.


Melden Sie sich im Shopware Backend an und öffnen Sie die E-Mail Vorlagen (Einstellungen - eMail-Vorlagen). Öffnen Sie die Vorlage "sORDER" unter "System emails".


Entfernen Sie im Mail-Text den Text zwischen {if $additional.payment.name == "prepayment"} und {/if}. Entfernen Sie den Text im Reiter "Plaintext" und HTML-Text!



Wenn Sie Ihren Shop in mehreren Sprachen betreiben, entfernen Sie den Text auch in den jeweiligen Übersetzungen (jeweils im Feld "Inhalt" und "Html-Inhalt").



Storno von Bestellpositionen mit Shopware ERP (Pickware)

Wenn Sie Shopware ERP (Pickware) verwenden, kann beim Stornieren einer Bestellung durch Komfortkasse auch eine Stornierung der Bestellpositionen erfolgen. Aktivieren Sie dazu in Ihrem Shop in der Konfiguration des Komfortkasse Plugins die Option "Bestellpositionen stornieren":

Nähere Informationen zu Subshops

Wenn Shopware Subshops verwendet werden, gibt es zwei Möglichkeiten diese in Komfortkasse anzubinden:

  1. Subshops in Komfortkasse nicht verwenden, nur einen Shop in Komfortkasse anlegen
  2. Subshops in Komfortkasse verwenden und mehrere Shops in Komfortkasse anlegen


Bei Option 1 wird in Komfortkasse nur ein Shop angelegt, die Bestellungen aller Subshops werden in diesem Shop eingelesen. Diese Option kann verwendet werden, wenn Subshops nur für Sprachen verwendet werden. Die Sprache wird in Komfortkasse automatisch erkannt und in der Bestellung hinterlegt, dazu müssen die Sprach-Subshops aus Shopware nicht in Komfortkasse angelegt werden.


Wenn verschiedene Shops mit z.B. verschiedenen Namen, Logos oder URLs verwendet werden, muss Option 2 verwendet werden. Dazu wird jeder Subshop in Shopware als eigener Shop in Komfortkasse angelegt. (Sprach-Subshops können dabei zusammengefasst werden - wenn also z.B. zwei Shops in je drei Sprachen in Shopware angelegt sind, müssen in Komfortkasse nur zwei Shops angelegt werden.)

Im Komfortkasse Händlerbereich wird dann beim jeweiligen Shop ausgewählt, welche Shopware Subshops verwendet werden sollen:

(Falls keine Subshops in der Liste vorhanden sind, sondern nur ein Textfeld angezeigt wird, müssen die Subshops zuerst durch "Werte neu auslesen" übertragen werden. Dazu muss der Benutzername und API Schlüssel eingetragen sein.)


Vorgehensweise für neu erstellten Subshop

Gehen Sie folgendermaßen vor, wenn Sie einen Subshop in Shopware neu erstellt haben und diesen in Komfortkasse einbinden möchten:

  1. Erstellen Sie zuerst den Shop in Komfortkasse ("Zusätzlichen Shop verbinden") und geben Sie die URL, Logo, E-Mail Einstellungen, etc. an.
  2. Hinterlegen Sie dann API Benutzername und API Schlüssel und speichern die Daten. (Ab diesem Zeitpunkt kann Komfortkasse mit dem Shop kommunizieren, und es können die benötigten Einstellungen wie Subshops, Zahlungsarten, Status, etc. ausgelesen werden.)
  3. Wählen Sie dann den korrekten Subshop (bzw. Subshops) aus der Liste aus und speichern Sie die Daten. Vergewissern Sie sich, dass die Subshops korrekt gespeichert wurden.
  4. Tragen Sie die gewünschten Status-Werte ein und stellen Sie die Verbindung her. 



Rückerstattungen

Rückerstattungen können direkt aus Shopware erstellt werden, ohne weiteren manuellen Eingriff. Weitere Informationen zur allgemeinen Funktion von Rückerstattungen finden Sie unter Rückerstattungen.


Eine Rückerstattung wird aus einem Dokument in Shopware erstellt. Dazu wird ein Dokumenten-Typ hinterlegt. Es kann ein Standard-Typ (z.B. "Gutschrift") verwendet werden, wir empfehlen jedoch, einen eigenen Dokumenten-Typ nur für diesen Zweck neu anzulegen (z.B. "Rückerstattung Überweisung" o.ä.).


Im Komfortkasse Händlerbereich muss in den Allgemeinen Einstellungen die Erstellung von Rückerstattungen aus dem Shopsystem aktiviert werden:

Hier muss also nur im Shopsystem oder im Shopsystem und im Händlerbereich gewählt werden.


In den Einstellungen des Komfortkasse Plugins in Shopware muss der gewünschte Dokumenten-Typ hinterlegt werden:



Komfortkasse führt einige Prüfungen aus, um unbeabsichtigte oder mehrfache Rückerstattungen zu vermeiden. Standardmäßig werden z.B. nur Rückerstattungen durchgeführt, zu denen in Komfortkasse ein Zahlungseingang vorliegt. Vor der Inbetriebnahme der automatischen Rückerstattungen sollte der Prozess unbedingt getestet werden.