Plugin: Bonus-System

Einleitung

Das Bonus-System von Shopware bietet Dir die Möglichkeit, Kunden für Bestellungen Bonuspunkte gut zu schreiben um Ihnen so einen Anreiz zu geben, erneut in Deinem Online Shop einzukaufen.

Die Bonuspunkte werden anhand des Warenkorbwertes mit Hilfe eines frei konfigurierbaren Faktors berechnet, der im Backend hinterlegt werden kann. Der Kunde kann mittels dieser Bonuspunkte bestimmte, durch den Shopbetreiber definierte, Artikel erwerben.

Zusätzlich hat der Kunde die Möglichkeit zur Verrechnung der Bonuspunkte in Form eines Gutscheins einzulösen. Auch hier lassen sich der Umrechnungsfaktor der Bonuspunkte sowie der einlösbare Maximalwert frei im Backend definieren.

Das Bonus-System ist Subshop-fähig! Du kannst für jeden einzelnen Sprach- und Subshop abweichende Einstellungen, Bonusartikel, Umrechnungsfaktoren usw. hinterlegen. Du hast auch die Möglichkeit, das Bonus-System nur für bestimmte Subshops freizuschalten.

Das Bonus-System kann nur dann greifen, wenn der Kunde auch ein Kundenkonto besitzt bzw. ein eigenes Kundenkonto erstellt. Bei Schnellbestellung ohne Kundenkonto können keine Bonus-Punkte gutgeschrieben werden. Als Shopbetreiber solltest du daher die Option "Schnellbestellung" deaktivieren, oder den Kunden auf diesen Umstand hinweisen.

Installation

Diese Erweiterung findest Du in unserem Shopware Store, der einfachste Weg, ein bestimmtes Plugin zu finden, ist die Suchleiste.
Nachdem Du den Bestellvorgang abgeschlossen hast, logge Dich in das Backend Deines Shops ein. Jetzt gehst du zu Konfiguration > Plugin-Manager > Meine Einkäufe. Du musst dich einloggen und auf die Schaltfläche Aktualisieren klicken. Die neue Erweiterung ist nun aufgelistet und kann installiert werden. Nach der Installation der Erweiterung gehst Du auf den Menüpunkt Installiert und aktualisierst die Übersicht. Jetzt kannst Du die Erweiterung aktivieren. Abschließend löscht Du unter Einstellungen > Cache/Performance > Shop-Cache löschen den Cache und aktualisierst das Backend.

E-Mail-Template

Sollen auch bei der Bestellbestätigungsmail die Bonuspunkte angezeigt werden, musst Du das sORDER-eMailtemplate anpassen. Öffne dazu unter Einstellungen die E-Mail-Vorlagen und editiere das Template sORDER. Im Plaintext findest du folgende Zeilen:

 
{$details.price|padding:8} EUR 
{$details.amount|padding:8} EUR		
 

Ersetze dies durch:

 
{if $details.isBonusArticle}
   {$details.points_per_unit|padding:8} Punkte
   {$details.required_points|padding:8} Punkte
{elseif $details.isBonusVoucher} 
   {$details.required_points|padding:8} Punkte
   $details.price|padding:8} EUR 
{else}
   {$details.price|padding:8} EUR 
   {$details.amount|padding:8} EUR	
{/if}
 

Im HTML-Text Feld finden Sie folgende Zeilen:

 
   <td>{$details.price|padding:8}{$sCurrency}</td>
   <td>{$details.amount|padding:8} {$sCurrency}</td>
 

Ersetze dies durch:

 
{if $details.isBonusArticle}
   <td>{$details.points_per_unit|padding:8} Punkte</td>
   <td>{$details.required_points|padding:8} Punkte</td>
{elseif $details.isBonusVoucher} 
   <td>{$details.required_points|padding:8} Punkte</td>
   <td>{$details.price|padding:8}{$sCurrency}</td>
{else}
   <td>{$details.price|padding:8}{$sCurrency}</td>
   <td>{$details.amount|padding:8} {$sCurrency}</td>
{/if}
 

Zusätzliche Variablen

• {$additional.sBonusPoints.spending} -> ausgegebene Punkte
• {$additional.sBonusPoints.remaining} -> übrige Punkte
• {$additional.sBonusPoints.earning} -> Punkte für die Bestellung
• {$additional.sBonusPoints.user} -> Punkte vor der Bestellung

Funktionen des Bonus-Systems

Im folgenden Bereich wird das Backend-Modul des Bonus-Systems erklärt:

Beim Öffnen des Moduls erscheint die Startseite des Bonus-Systems, in dem die Funktionen des Plugins aufgelistet werden. Mit diesen 7 Bereichen sind die Funktionen des Bonus Systems für den jeweiligen Shop komplett abgedeckt. Beachte, dass hier getätigte Einstellungen für für den gewählten Shop gelten und nicht auf die anderen Shops vererbt werden.

Auf der linken Seite befindet sich eine Auswahl der verfügbaren Funktionen:

• Einstellungen (1)
• Kunden (2)
• Bonusartikel (3)
• Artikel (4)
• Kategorien (5)
• Angebote (6)
• Bestellungen (7)

Bevor Du Einstellungen tätigst, wähle vorab den Shop aus (1).

Einstellungen

In diesem Bereich kannst Du die verschiedenen Einstellungen zum Bonus-System (1) treffen. Die Einstellungen unterteilen sich in drei Bereiche:

• Allgemein
• Bonuspunkte Verrechnung
• Template

Allgemein

Im Bereich Allgemein stehen dir folgende Optionen zur Verfügung:

• Wartungsmodus aktivieren (1)

Wenn der Wartungsmodus aktiviert ist, wird das gesamte Modul im Frontend inaktiv und alle Elemente im Frontend werden ausgeblendet. Anders als im Wartungsmodus von Shopware bleibt der Shop dabei aber erreichbar.

• Bonusartikel aktivieren (2):

Wenn dieser Punkt aktiv ist, werden die eingerichteten Bonusartikel im Frontend zur Auswahl angezeigt.

• Umrechnungsfaktor Bonuspunkte (3):

Dieser Faktor gibt an, ab wie viel Euro der Kunde einen Bonuspunkt gutgeschrieben bekommt. Bei der Berechnung der Bonuspunkte werden die Versandkosten nicht mit einbezogen. Mindermengenzuschläge hingegen schon.

• Freischaltung der Bonuspunkte (4):

Hier kann definiert werden, wann die Bonuspunkte freigeschaltet werden. Hast Du hier die Option "Wenn Bestellung auf bezahlt", so werden die Bouspunkte der Bestellung beim Setzen des Zahlstatus "Komplett bezahlt" direkt freigeschaltet, spätestens aber bei Ausführung des Cronjobs. Weitere Informationen findest Du in den Hilfetexten der Elemente.

Wenn eine Bestellung auf "bezahlt", bezieht sich das auf den Zahlungsstatus "komplett bezahlt" der jeweiligen Bestellung!

• Rundung der Bonuspunkte (5):

Definiere hier, wie bei der Berechnung der Bonuspunkte gerundet werden soll.

• Tage bis zur Freischaltung (6):

Hier kann definiert werden, nach wie vielen Tagen die Bonuspunkte automatisch freigeschaltet werden. Die Freischaltung wird dann per Cronjob durchgeführt und auch nur dann, wenn die Aktivierungsmethode Nach "x" Tagen freischalten aktiv ist. Voraussetzung für diese Funktion ist, dass das Plugin Cron installiert und aktiv ist. Der Cronjob SwagBonusSystemCron kann dann in einem beliebigen Interval ausgeführt werden und schreibt den Kunden die Punkte gut.

• Einlösen auf der Bestell-Abschluss-Seite ermöglichen (7):

Wenn dies Option aktiv ist, bietest Du deinen Kunden die Möglichkeit Bonuspunkte auf der Bestell-Abschluss-Seite einzulösen.

• Berücksichtige Gutschein Bonuspunkte (8):

Wenn diese Funktion aktiviert ist, beeinflussen Gutscheine die Bonuspunkteberechnung.

• Modus für die Bonuspunkteberechnung (9):

Hier kannst Du definieren, ob Rabatte und Aufschläge (z.B. Aufschläge für Zahlungsarten oder Warenkorbrabatte) bei der Berechnung der Bonuspunkte berüchsichtigt werden sollen.

• Kundengruppe ausschließen (10):

Hier kannst Du bestimmte Kundengruppen vom Bonus Programm ausschließen.

Die Cronjob-Funktion ermöglicht ein automatisiertes abarbeiten verschiedenster Funktionen. Der für das Bonus-System zuständige Cronjob wird in die Liste der Standard-Cronjobs von Shopware hinterlegt. Wenn Du die Cronjobs bereits nutzt, wird der Cronjob für das Bonus-System automatisch integriert, es ist kein weiterer Eingriff erforderlich.

Wenn Du Cronjobs bisher noch nicht nutzt, sind verschiedene Einstellungen in Shopware und am Server zu treffen. Weitere Infos zum Thema Cronjobs findest Du in folgendem Artikel: Shopware Cronjobs.

Bonuspunkte Verrechnung

Im Bereich "Bonuspunkte Verrechnung" stehen dir folgende Optionen zur Verfügung:

• Verrechnung aktivieren (1):

Sobald dieser Punkt aktiviert ist, kann der Shop Kunde seine Bonuspunkte im Warenkorb in Euro eintauschen. Hierfür generiert Shopware automatisch einen neuen Gutschein und fügt diesen dem Warenkorb hinzu.

• Umrechnungsfaktor (2):

Wie im Bereich Allgemein wird hier der Faktor für die Umrechnung der Bonuspunkte definiert. Anders als im Bereich Allgemein wird hier jedoch angegeben, wie viele Punkte einem Euro entsprechen. Bitte beachte, dass erst ab einem Punktewert von 1 Euro Bonuspunkte eingelöst werden können. Erst ab diesem Betrag erscheint im Frontend (Warenkorb) die Verrechnungs-Maske.

• Art der Verrechnungsbeschränkung (3):

Die Umwandlung von Bonuspunkten in Euro kann hier beschränkt werden. Es besteht die Möglichkeit, einen fixen Eurobetrag einzutragen oder die Beschränkung relativ zum Bestellwert zu bestimmen.

• Wert der Beschränkung (4):

Hier wird der Euro Betrag für die Einschränkung hinterlegt.

Template

Im Bereich Template stehen dir folgende Optionen zur Verfügung:

• Text für das Bonusartikel Listing (1):

Dieser Text wird im Listing der Bonusartikel im Frontend angezeigt.

• Banner anzeigen (2):

Da das Upload-Feld das Anzeigen bestehender Daten bzw. Bilder nicht unterstützt, kann das Banner über diesen Punkt deaktiviert werden. Beim hochladen einer Grafikdatei wird diese im Hintergrund an den Server übertragen.

• Akkordeon anzeigen (3):

Wenn dieser Punkt aktiviert ist, wird das Bonusartikel Akkordeon auf der Startseite und den Kategorie-Listings angezeigt. Optisch entspricht das dem des Hersteller Accordeons auf der rechten Seite der Startseite deines Shops. Diese Funktion kann zusammen mit Einkaufswelten genutzt werden.

• Bonusartikel Slider anzeigen (4):

Wenn dieser Punkt aktiviert ist, wird der Bonusartikel Slider im Warenkorb und auf der Startseite (auch in Verbindung mit Einkaufswelten) angezeigt.

• Banner für das Bonusartikel Listing (5):

Das Upload-Feld unterstützt keine Darstellung bestehender Grafiken. Du kannst die Funktion also ausschließlich zum erstmaligem hochladen oder späterem Überschreiben bestehender Grafiken verwenden.

• Template-Auswahl (6):

Hier kannst Du das Template für das Bonus System Listing wählen, welches unter https://domain.de/BonusSystem aufgerufen werden kann.

Kunden

In diesem Tab kannst Du die verschiedenen Punktestände der Shop Kunden auslesen und diese manuell durch einen Doppelklick auf den Punktestand (1) bearbeiten. Diese Funktion spielt eine große Rolle, da das Bonus System keine Bonuspunkte automatisiert zurück bucht, wenn z.B. eine Bestellung storniert wird. Sobald die Anpassung der Punkte abgeschlossen ist, kannst Du über den Update-Button (2) die Änderungen übernehmen.

Bonusartikel

In diesem Tab können Artikel hinzugefügt werden, welche Du für Bonuspunkte anbieten möchten. Gehe hierzu einfach in das Suchfeld (1) und suche nach dem gewünschten Artikel. Anschließend hinterlegst Du noch die Bonupunkte (2), die benötigt werden um den Artikel für Bonuspunkte zu erwerben. (Du kannst hier jeweils Stammartikel wählen. Bei einem Varianten-Artikel wird jede Variation für die definierten Bonuspunkte angeboten.)

Artikel

Hier können Artikel von Bonuspunkten ausgeschlossen werden. Für alle Artikel die hier hinterlegt sind erhält dein Kunde beim Kauf keine Bonuspunkte. Über die Such-Maske (1) kannst Du über den Artikelnamen und Artikel-Nummer einen gewünschten Artikel suchen und auswählen.

Kategorien

Hier hast Du die Möglichkeit Kategorien von Bonuspunkten auszuschließen. Füge über das Suchfeld (1) einfach eine Kategorie hinzu die Du ausschließen möchtest. Der Kunde erhält nun keine Bonuspunkte mehr für Artikel, welche sich in der Kategorie befinden. Die in der Kategorie befindlichen Artikel können ebenfalls nicht mehr als Bonusartikel definiert werden. 

Angebote

Diese Optionen bietet dir die Möglichkeit für bestimmte Artikel abweichende Bonuspunkte zu gewähren. Gehe in das Suchfeld (1) und füge den gewünschten Artikel hinzu, für den Du abweichende Bonuspunkte gewähren möchtest. Anschließend wähle ein Angebotstyp (2) aus.

• Fest Hier wird dem Kunden eine feste Bonuspunktzahl für den Artikel gegeben. Den Wert hinterlegst Du in Angebotswert (3)
• multiplizieren mit Wenn Du diese Option wählst, werden die ursprünglichen Punkte multipliziert mit dem Angebotswert (3)

Zudem hast Du noch die Möglichkeit die Angebote Zeitlich zu beschränken (4)

Bestellungen

In diesem Tab werden alle Bestellungen aufgelistet, welche seit der Aktivierung des Bonus Systems getätigt wurden. Das trifft auch auf die Anzahl der Bonuspunkte (2) zu, welche der Kunde für diese Bestellung erhält. Mithilfe der Suche (1) in der Toolbar können bestimmte Bestellungen schnell und einfach gefunden werden. Über die Icons Kunde öffnen & Bestellung öffnen (3) kannst Du direkt in die passende Maske springen.

Bonuspunkte manuell freischalten:

Markiere (4) die betreffenden Bestellungen und klicke danach auf den Button Markierte freigeben (5).

Elemente im Front- und Backend

Sobald das Bonus System von Shopware aktiviert ist, finden Sie im Frontend einige neue Elemente.

Akkordeon

Sollten die Bonusartikel aktiviert und definiert sein, befindet sich nun im Kategorie Listing ein Akkordeon mit den ersten fünf Bonusartikeln. Diese werden über das Feld „Position“ sortiert. Am Ende des Akkordeons befindet sich ein Link „Alle anzeigen“ über den der Benutzer zum Listing der Bonusartikel gelangen kann.

Artikel Slider

Zusätzlich zum Akkordeon wird im Warenkorb und auf der Startseite ein Artikel Slider mit allen Bonusartikeln angezeigt. Dieser kann, wie auch das Akkordeon über das Backend optional deaktiviert werden.

Mein Konto

Sobald der Benutzer eingeloggt ist, werden neben "Mein Konto" die Bonuspunkte des Benutzers (1) dargestellt.

Bei einem Klick auf "Sie besitzen X Bonuspunkte" erscheinen zwei Links, die zu den Bonusartikeln und zum Punktekonto des Benutzers (2) führen.

Listing aller Bonusartikel

Für die Bonusartikel wurde ein neues Listing hinzugefügt (www.ihrshop.de/BonusSystem), hier werden alle Bonusartikel, welche im Backend definiert wurden angezeigt. Wenn der Benutzer eingeloggt ist, werden die Punkte für den Artikel orange angezeigt sofern er bereits genügend Punkte gesammelt hat. Sollte der Benutzer noch nicht ausreichend Punkte für den Artikel besitzen, werden die restlichen benötigten Punkte in der darunter liegenden Zeile rot angezeigt.

Detailseite

Damit der Benutzer auf der Detailseite eines Artikel sehen kann, wie viele Punkte er für den Artikel gutgeschrieben bekommen würde, befindet sich unterhalb des "Kaufen"-Buttons ein neues Element zur Anzeige der gutzuschreibenden Punkte (1).

Für die Unterscheidung, ob der Artikel für Bonuspunkte oder für Euro (1) gekauft werden soll, wurden zwei Radiobuttons oberhalb des "Kaufen"-Buttons hinzugefügt. Die hier angezeigten Preise/Punkte beziehen sich auf den Stückpreis.

Warenkorb

Unterhalb der Warenkorb Summe wird ein neues Element hinzugefügt, welches zur Anzeige der ausgegebenen und gut zu schreibenden Punkte (1) zuständig ist:

Artikel welche für Bonuspunkte gekauft werden, werden hier mit einer besonderen Kennzeichnung (2) angezeigt.

Für die Verrechnung der Bonuspunkte in Euro wurde das jQuery UI eingebunden. Hierfür wird die Slider Komponente verwendet. Der Benutzer kann ganz einfach den Slider Regler (3) von einer Seite zur anderen ziehen und so den Wert für die Verrechnung bestimmen.

Bitte beachte, dass der Slider (3) erst ab einem Punktestand von umgerechnet 1 Euro angezeigt wird.

Wie bei den Bonusartikeln werden auch die eingelösten Bonuspunkte als Gutschein (1) in einer separaten Bestellposition aufgelistet und mit einer besonderen Kennzeichnung angezeigt:

Des Weiteren befindet sich unterhalb des "Zur Kasse gehen" Buttons ein weiterer Bonusartikel Slider, wie er auch auf der Startseite angezeigt wird. Hier kann der Kunde nochmals sehen, was er für die Bonuspunkte kaufen könnte. Dieser Slider kann über das Backend ausgeblendet werden.

E-Mail

Solltest du dein E-Mailtemplate wie in der Plugin Installation beschrieben angepasst haben, werden auch hier die Summen der Bonuspunkte angezeigt

Account

Im "Mein Konto"-Bereich des Benutzers wurde ein weiterer Punkt hinzugefügt: Ihr Punktekonto (1). Hier werden alle Bestellungen angezeigt, bei denen der Benutzer Punkte gesammelt oder ausgegeben hat. In der Übersicht "Meine Bestellungen" werden ebenfalls die eingelösten Punkte für die Positionen dargestellt. Hier kann der Kunde zu dem den Status der Freischaltung seiner Bonuspunkte (2) einsehen.

Einbindung der Bonus System Komponenten

Bevor die Komponenten individuell ins Template eingebunden werden, sollte vorher eine Prüfung stattfinden, ob das Bonus System und die Bonusartikel aktiviert sind:

 
{if $sBonusSystem.settings.bonus_articles_active && $sBonusSystem.settings.display_article_slider==1}
    -- Gewünschte Komponente (siehe unten)
{/if}
 

Akkordeon:

 
{include file='frontend/plugins/swag_bonus_system/accordion/accordion.tpl'}
 

Artikel Slider mit Bonusartikeln:

 
{include file="frontend/plugins/swag_bonus_system/recommendation/slider.tpl"}
 

Dieses stellt nur die mögliche Erweiterung dar. Eine manuelle Integration ist standardmäßig nach Installation des Plugins nicht nötig.