Read this article in English (AI translated)

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


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


Einrichtung der Shopware 6 API


Für den Zugriff von Komfortkasse auf den Shopware Shop muss eine Integration unter Einstellungen - System - Integrationen angelegt werden:



Sie können die Integration z.B. "komfortkasse" nennen. Aktivieren Sie die Schreibrechte mit der Checkbox Schreiben (in neueren Versionen von Shopware aktivieren Sie statt der Checkbox Schreiben den Administrator-Zugriff).


Weitere Informationen zu benötigten Rollen/Berechtigungen

Wir empfehlen, für die Integration Administrator-Rechte zu verwenden. Falls eine benutzerdefinierte Rolle verwendet wird, sind zumindest folgende Berechtigungen erforderlich:

  • read: order, order_transaction, order_delivery, order_address, order_line_item, order_customer, customer, salutation, country, currency, language, locale, document, document_type, payment_method, state_machine, state_machine_state, sales_channel, sales_channel_domain, plugin
  • update: order, order_transaction

order: update wird nur benötigt, wenn Komfortkasse den Bestellstatus ändern soll.



Speichern Sie die Integration mit dem Button Integration speichern.


Hinterlegen Sie die Zugangs-ID und den Sicherheitsschlü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 Zahlungsarten, Verkaufskanäle und Bestellstatus. Während die Daten ausgelesen werden, wird die ID oder der technische Name des entsprechenden Eintrags angezeigt (z.B. "open"). Sie sehen möglicherweise auch eine entsprechende Anzeige neben dem jeweiligen Feld:


API-Einstellungen

Wenn die Daten erfolgreich ausgelesen wurden, werden statt der IDs die korrekten Bezeichnungen (z.B. "Offen") 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 Zahlungsarten, Verkaufskanälen, und Status vornehmen.

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


Verkaufskanäle

Wenn nur ein Verkaufskanal vorhanden ist (oder wenn alle vorhandenen Verkaufskanäle in Komfortkasse verwendet werden sollen), dann muss hier keine Auswahl getroffen werden.

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

Wenn Verkaufskanäle verschiedene Shops repräsentieren (also z.B. mit eigener URL, Name oder Logo), dann muss pro Verkaufskanal in Komfortkasse ein Shop angelegt werden. Pro Shop muss dann hier der zugeordnete Verkaufskanal ausgewählt werden.


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 "Banküberweisung / 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. Die Zahlungsstatus für Teilzahlung und Mahnstufen gelten automatisch als offen. Weitere Status (z.B. "Erinnert") müssen Sie nur eintragen, wenn Ihr Shop sie selbst setzt:


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. Die Felder erscheinen für die Anzahl der eingestellten Mahnungen. Das Feld für Inkasso erscheint nur, wenn Sie das Inkasso nutzen.


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.


Einstellungen für Zahlung auf Rechnung 

Für Zahlung auf Rechnung stehen dieselben Einstellungen wie für Vorkasse zur Verfügung, mit Ausnahme der Zahlungsweisen für Überwachung. Außerdem gibt es einen 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.

Es können jeweils kommagetrennt Dokument-Typen oder benutzerdefinierte Felder aus Shopware hinterlegt werden:


Dokumenttypen oder benutzerdefinierte Felder für Rechnungsnummern: Kommagetrennt die technischen Namen der Dokumenttypen oder die Namen benutzerdefinierter Felder der Bestellung. Deren Nummer übernimmt Komfortkasse als Rechnungsnummer. Voreinstellung: invoice, storno, credit_note, zugferd_embedded_invoice, zugferd_embedded_cancellation_invoice, zugferd_embedded_credit_note

Dokumenttypen für Rechnungs-Stornos: Ein Storno dieses Typs hebt die Rechnung auf, auf die es sich bezieht. Weder die Rechnungsnummer noch die Stornonummer wird übernommen. Voreinstellung: storno, zugferd_embedded_cancellation_invoice

E-Rechnungen (ZUGFeRD/XRechnung): Rechnungen, Stornos und Gutschriften, die Shopware nur als XML-Datei erstellt (z.B. für Behörden), behandelt Komfortkasse automatisch wie die entsprechenden Dokumente. Voraussetzung ist, dass der Grundtyp (z.B. invoice) oder die PDF-Variante (z.B. zugferd_embedded_invoice) eingetragen ist. Sie müssen dafür nichts ergänzen. Eine reine XML-Datei wird nicht als Rechnungs-PDF übernommen.


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.


E-Mail Adresse aus Plugin „E-Mail Adresse für Rechnungen“

Wenn aktiv, verwendet Komfortkasse die E-Mail-Adresse aus diesem Plugin statt der Bestell-E-Mail, sofern beim Kunden eine hinterlegt ist.


Metafield-Namen für Briefversand

Name eines benutzerdefinierten Felds der Bestellung. Steht es auf „true“, verschickt Komfortkasse die Rechnung zusätzlich per Brief, sobald das Rechnungs-PDF vorliegt.


Zahlungsdetails zum Shop übertragen

Wenn diese Einstellung aktiv ist, überträgt Komfortkasse Details zu Zahlungseingängen in ein benutzerdefiniertes Feld (Custom Field) an der Zahlungstransaktion der Bestellung in Shopware.

Die Daten werden als Custom Field mit dem Namen komfortkasse an der Transaktion (order_transaction) der Bestellung hinterlegt und enthalten:

  • amount – Bestellbetrag in der Zahlungswährung
  • currency – Zahlungswährung
  • amountMissing – noch offener Betrag (0, wenn vollständig bezahlt)
  • reminderFees – bisher angefallene Mahngebühren
  • postings – Liste der eingegangenen Zahlungen, jeweils mit Buchungsdatum (postingDate), Betrag (amount), Währung (currency) und Bankgebühren (bankFees)

Die Übertragung erfolgt immer gemeinsam mit einer Status-Übertragung an den Shop, also beim Zahlungseingang (Teilzahlung oder vollständige Zahlung) sowie bei Stornierung, Rückerstattung, Mahnung oder Inkasso.

Solange zu einer Bestellung noch keine Zahlung eingegangen ist, greift Komfortkasse ausschließlich lesend auf den Shop zu. An der Bestellung ist dann noch nichts zu sehen — das ist kein Fehler und kein Hinweis auf eine fehlende Einstellung. Bei jeder weiteren Teilzahlung werden die Daten aktualisiert.

Voraussetzungen: 

Bei der jeweiligen Zahlungsart muss ein Zahlungsstatus hinterlegt sein (z.B. unter „Bestellstatus und Zahlungsstatus für bezahlte Bestellungen"). Ist dort durchgehend „nicht ändern" gewählt, wird auch das Custom Field nicht geschrieben.

Außerdem benötigt die Integration Schreibrechte auf order_transaction (siehe „Weitere Informationen zu benötigten Rollen/Berechtigungen" am Anfang dieses Artikels).


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.