Gutschein-Eingabe vorsehen - WEBSALE Dokumentation

Angelegte Gutscheine nützen nichts, solange der Kunde sie nicht eingeben kann. Diese Seite beschreibt, wie das Eingabefeld in den Bestellablauf kommt, wie die Rückmeldungen dazu gestaltet werden und welche zwei Sonderfälle zusätzliche Arbeit verursachen. Der wichtigste Punkt vorweg: Eine eingetippte Gutscheinnummer allein bewirkt nichts. Der Kunde muss den Gutschein über einen Button aktivieren, erst dann prüft ihn der Shop. Ohne diese Aktivierung wird der Gutschein im weiteren Bestellablauf ignoriert.

Wie das Einlösen im Shop abläuft

Die Eingabe ist auf der Warenkorbseite ws_basket.htm, auf der Bestellübersichtsseite ws_place_order.htm oder auf beiden möglich.

Was der Kunde tut	Was der Shop tut
gibt eine Nummer ein und klickt “Gutschein einlösen”	prüft die Nummer und übernimmt den Gutschein
gibt eine ungültige Nummer ein	zeigt eine Meldung mit dem Grund an
klickt “Gutschein entfernen”	leert das Feld, der Bestellablauf geht ohne Gutschein weiter

Ohne Klick auf “Gutschein einlösen” passiert nichts. Eine Nummer, die nur im Feld steht, wird beim Bestellabschluss nicht berücksichtigt. Bauen Sie den Button deshalb so auffällig ein, dass niemand ihn übersieht.

Nach erfolgreicher Prüfung sieht der Kunde die Ersparnis oder das zugesteuerte Produkt sofort. Bieten Sie ihm auch danach einen “Gutschein entfernen”-Button an, damit er seinen Gutschein für eine spätere Bestellung aufheben kann. Versucht jemand, einen personalisierten Gutschein ohne Anmeldung einzulösen, lässt sich innerhalb der Fehlermeldung ein Login-Formular anzeigen. Nach der Anmeldung kann der Käufer automatisch wieder auf die Warenkorbseite geleitet werden, um den Gutschein erneut einzugeben. Wegweiser: Mehrere Gutscheine einlösen

Gutscheinnummern per Link übergeben

Eine Gutscheinnummer lässt sich schon beim Aufruf des Shops im URL-Parameter voucher_number mitgeben, beispielsweise über einen Link aus einem Newsletter. Der Shop trägt sie dann im Bestellablauf automatisch in das Eingabefeld ein.

https://www.beispielshop.de/?voucher_number=123456

Der Parameter wird mit ? eingeleitet, wenn er der erste in der Adresse ist, und sonst mit & angehängt.

Auch eine per Link übergebene Nummer steht zunächst nur im Feld. Geprüft und übernommen wird sie erst, wenn der Kunde “Gutschein einlösen” anklickt. Ein Newsletter-Link allein löst den Gutschein also nicht ein.

Materialien: URL-Parameter · Wegweiser: Newsletter-Gutscheine

Gutschein im stationären Handel einlösen

Betreiben Sie zusätzlich ein Ladengeschäft, können Sie die Gutscheinnummer als Barcode auf den Gutschein drucken und an der Kasse einscannen lassen. Den Barcode erzeugt das Tag WS-BarcodeURL als Bild.

<img src="~WS-BarcodeURL($INSTANTVOUCHER-VoucherNumber$,TYPE_CODE_128_A,3,JPG)~" alt="Gutscheincode als Barcode">

Das Tag funktioniert auf jedem Template. Wo Sie es platzieren, hängt davon ab, welche Gutscheinart Sie anbieten, also ob auf dem Kaufgutschein zum Ausdrucken, im Newsletter-Gutschein oder auf dem Neukunden-Gutschein. Referenz: WS-BarcodeURL

Die Gutschein-Eingabe integrieren

Für Gutschein-Features gibt es die Tag-Familie VOUCHER-. Die älteren WS-Voucher…-Tags werden weiterhin unterstützt, sollten aber in neuen Integrationen nicht mehr verwendet werden. Mischen Sie beide Familien nicht, auch nicht beim Aktualisieren einer bestehenden Integration. Die einzige Ausnahme ist WS-VoucherNumber_input, das unverändert weiterverwendet wird.

Schritt 1: Freischaltung

Wollen Sie den Gutschein-Generator nutzen, muss dieser für Ihren Shop freigeschaltet werden. Wenden Sie sich dafür an Ihren WEBSALE-Ansprechpartner. Verwenden Sie Gutscheine, die ein externes System erzeugt und die deshalb nicht im WEBSALE-Format vorliegen, ergänzen Sie im Abschnitt <Voucher-Txt> der shop.config den Eintrag ExternalVouchers-Allow = yes. Wegweiser: Gutscheine anlegen oder importieren

Schritt 2: Einstellungen in der Shopkonfiguration

Alle Gutscheinparameter stehen in der shop.config im Abschnitt <Voucher-Txt>.

<Voucher-Txt>
   Name                                          = Gutschein
   Remainder2                                    = Verfügbarer Restbetrag für Ihre nächste Bestellung:
   SpecialSettings1-Allow                        = no
   VoucherNotApplicable                          = Der eingegebene Gutschein ist mit diesen Produkten leider nicht verwendbar
   UsedVoucherNumber                             = (verwendete Gutscheinnummer: ~VoucherNumber~)
   ShowPercentalVoucherDiscountForPosition-Allow = no
   VoucherInputLocation                          = PlaceOrder,Basket
</Voucher-Txt>

VoucherInputLocation legt fest, auf welchen Seiten der Shop eine Gutscheineingabe erwartet.

Wert	Wirkung
`Basket`	nur auf der Warenkorbseite
`PlaceOrder`	nur auf der Bestellübersichtsseite
`PlaceOrder,Basket`	auf beiden Seiten
`PlaceOrderAndBasket`	gleichbedeutend mit `PlaceOrder,Basket`, nur aus Kompatibilitätsgründen erhalten

Der Eintrag ist eine kommagetrennte Liste, keine Auswahl aus drei festen Schlüsselwörtern. Erkennt der Shop keinen der Werte, verwendet er Basket.

Der Wert muss zu dem passen, was Sie tatsächlich in die Templates einbauen. Ein Eingabefeld auf einer Seite, die hier nicht genannt ist, bleibt wirkungslos, und der Kunde klickt vergeblich.

Referenz: Abschnitt Voucher-Txt

Schritt 3: Eingabefeld und Buttons platzieren

Das Eingabefeld und die beiden Buttons gehören innerhalb von FORM-Basket beziehungsweise FORM-PlaceOrder, weil sie nur dann mit dem Formular abgeschickt werden.

<form action="~FORM-Basket~" method="post">
   <!-- oder: <form action="~FORM-PlaceOrder~" method="post"> -->

   {!VOUCHER-Number}
      <!-- Es liegt noch keine Gutscheinnummer vor, also das Eingabefeld zeigen -->
      Gutscheinnummer:
      <input type="text" name="~WS-VoucherNumber_input~" value="">
      <input type="submit" name="~BT-Voucher~" value="Gutschein einlösen">
   {/!VOUCHER-Number}

   {VOUCHER-Number}
      <!-- Es liegt eine Nummer vor, eingetippt oder per Link übergeben -->
      {ST-Voucher_checked}
         {!ST-Voucher_OK}
            <span class="voucher-error">
         {/!ST-Voucher_OK}
      {/ST-Voucher_checked}

      Gutscheinnummer: ~VOUCHER-Number~
      <input type="submit" name="~BT-Voucher_delete~" value="Gutschein entfernen">

      {ST-Voucher_checked}
         {!ST-Voucher_OK}
            </span>
         {/!ST-Voucher_OK}
      {/ST-Voucher_checked}
   {/VOUCHER-Number}

</form>

Die beiden Abschnitte {VOUCHER-Number} und {!VOUCHER-Number} schließen einander aus. Solange keine Nummer vorliegt, sieht der Kunde das Eingabefeld, danach die eingegebene Nummer mit dem Entfernen-Button. So steht nie beides gleichzeitig auf der Seite. ST-Voucher_checked sagt aus, dass die Nummer bereits geprüft wurde, ST-Voucher_OK, dass sie gültig ist. Erst beide zusammen erlauben die Aussage “geprüft und nicht gültig”, die hier die fehlerhafte Eingabe hervorhebt. Referenz: BT-Voucher · BT-Voucher_delete · VOUCHER-Number · VOUCHER-ChargeID · WS-VoucherNumber_input · ST-Voucher_OK · ST-Voucher_checked

Schritt 4: Meldungen platzieren

Erfolgs- und Fehlermeldungen platzieren Sie frei auf denselben Seiten, auf denen Sie die Eingabe eingebaut haben. Jede Meldung ist ein eigener Abschnitt mit dem Grund als Parameter, sodass Sie Wortlaut und Gestaltung vollständig selbst bestimmen.

{MSG-Voucher_success}
   <div class="voucher-success">
      {MSG-Voucher_success(1)}Der Gutschein wurde übernommen.{/MSG-Voucher_success(1)}
      {MSG-Voucher_success(2)}Der Gutschein wurde entfernt.{/MSG-Voucher_success(2)}
   </div>
{/MSG-Voucher_success}

{MSG-Voucher_error}
   <div class="voucher-error">
      {MSG-Voucher_error(2)}Ungültige Gutscheinnummer. Bitte überprüfen Sie Ihre Eingabe.{/MSG-Voucher_error(2)}
      {MSG-Voucher_error(3)}Dieser Gutschein ist erst ab dem ~MSG-Voucher_error_validfrom~ gültig.{/MSG-Voucher_error(3)}
      <!-- weitere Gründe nach demselben Muster, siehe Tabelle -->
   </div>
{/MSG-Voucher_error}

Der äußere Abschnitt allein zeigt nichts an. Erst die inneren Abschnitte mit Parameter erzeugen Text. Ein Grund, für den Sie keinen Abschnitt hinterlegt haben, führt dazu, dass der Kunde eine leere Meldung sieht und nicht weiß, warum sein Gutschein abgelehnt wurde. Legen Sie deshalb für jeden Grund einen Text an, den Sie im Shop auslösen können.

Die folgenden Gründe kennt der Shop. Die Textvorschläge sind als Ausgangspunkt gedacht und sollten an Ihre Tonalität angepasst werden.

Grund	Wann er auftritt	Textvorschlag
1	Gutscheineingabe wegen zu vieler Fehlversuche gesperrt	Die Gutscheineingabe wurde gesperrt. Sie können für diese Bestellung keinen Gutschein verwenden.
2	Nummer ungültig, dazu zählen auch falsche Währung und falscher Subshop	Ungültige Gutscheinnummer. Bitte überprüfen Sie Ihre Eingabe.
3	Gutschein noch nicht gültig	Dieser Gutschein ist erst ab dem `~MSG-Voucher_error_validfrom~` gültig. Bestellen Sie zu diesem Zeitpunkt oder verwenden Sie einen anderen Gutschein.
4	Gutschein abgelaufen	Dieser Gutschein ist abgelaufen.
5	Gutschein bereits verbraucht	Der Gutschein wurde bereits eingelöst.
6	personalisierter Gutschein, Kunde nicht angemeldet	Bitte melden Sie sich an, um diesen Gutschein einzulösen.
7	personalisierter Gutschein, bereits eingelöst	Dieser Gutschein wurde bereits eingelöst.
8	kategorie- oder produktabhängiger Gutschein, Warenkorb passt nicht	Dieser Gutschein gilt nicht für die Produkte in Ihrem Warenkorb.
9	personalisierter Gutschein, gilt nur für Neukunden	Dieser Gutschein gilt nur für Neukunden.
10	personalisierter Neukundengutschein, Anmeldung nötig	Dieser Gutschein gilt nur für Neukunden. Bitte melden Sie sich an.
11	Gutschein gilt nur für Neukunden	Dieser Gutschein gilt nur für Neukunden.
12	Neukundengutschein, Anmeldung nötig	Dieser Gutschein gilt nur für Neukunden. Bitte melden Sie sich an.
13	maximale Anzahl an Einlösungen erreicht	Dieser Gutschein wurde bereits vollständig eingelöst.
14	Gutschein nicht anwendbar und Bestellung deshalb gesperrt	Mit diesem Gutschein können Sie nicht bestellen, weil er auf kein Produkt im Warenkorb zutrifft. Entfernen Sie ihn oder legen Sie ein passendes Produkt in den Warenkorb.
15	Gutschein auf bestimmte Kunden beschränkt, Anmeldung nötig	Für diesen Gutschein müssen Sie angemeldet sein.
16	Gutschein auf bestimmte Kunden beschränkt, dieser Kunde gehört nicht dazu	Dieser Gutschein gilt nur für bestimmte Kunden.
17	kundengebundener Universalgutschein, Anmeldung nötig	Für diesen Gutschein müssen Sie angemeldet sein.
18	kundengebundener Universalgutschein, an ein anderes Konto gebunden	Dieser Gutschein ist an ein anderes Kundenkonto gebunden.
19	Sonderfunktion Garantie, Kunde nicht angemeldet	Für diesen Gutschein müssen Sie angemeldet sein.
20	Sonderfunktion Garantie, Gutschein kann nicht gelöscht werden	Dieser Gutschein kann nicht entfernt werden. Bitte melden Sie sich ab und beginnen Sie die Bestellung neu.
21	Sonderfunktion Filter auf zusätzliche Produktfelder, Warenkorb passt nicht	Dieser Gutschein gilt nicht für die Produkte in Ihrem Warenkorb.
22	Sonderfunktion Lagerbestand, kein Produkt mit passendem Bestand im Warenkorb	Dieser Gutschein gilt nur für Produkte mit bestimmtem Lagerbestand.
23	Kunde von Gutscheinaktionen ausgeschlossen	Für Ihr Kundenkonto sind Gutscheine nicht freigeschaltet.
24	Gutschein nur in der App einlösbar	Diesen Gutschein können Sie nur in unserer App einlösen.
25	im Kundenkonto ist ein Rabatt oder eine Rabattliste hinterlegt	Dieser Gutschein ist nicht mit Ihrem Kundenrabatt kombinierbar.
26	dieselbe Gutscheinnummer wurde mehrfach eingegeben	Diese Gutscheinnummer haben Sie bereits eingegeben.
27	Gutschein nicht mit anderen Gutscheinen kombinierbar	Dieser Gutschein lässt sich nicht mit anderen Gutscheinen kombinieren.

Mehrere Gründe führen zur selben Aussage, beispielsweise 9 und 11 oder 15, 17 und 19. Der Shop unterscheidet sie, weil intern verschiedene Prüfungen greifen. Für den Kunden dürfen die Texte gleich lauten, ein eigener Abschnitt pro Grund ist trotzdem nötig. Referenz: MSG-Voucher_success · MSG-Voucher_error · MSG-Voucher_error_validfrom

Schritt 5: Link zum Entfernen platzieren (optional)

Ergänzend zum Button können Sie einen Link anbieten, mit dem der Kunde einen gültigen Gutschein wieder loswird, solange die Bestellung nicht abgeschlossen ist.

{ST-Voucher_OK}
   <a href="~BASKET-VoucherDeleteLink~">Gutschein entfernen</a>
{/ST-Voucher_OK}

Referenz: BASKET-VoucherDeleteLink

Bestellabschluss mit nicht anwendbaren Gutscheinen unterbinden

Standardmäßig darf der Kunde bestellen, auch wenn sein gültiger Gutschein auf diese Bestellung gar nicht wirkt. Das ist bewusst so, denn der Kunde muss dann nicht erst einen zusätzlichen Klick aufwenden, um den Gutschein zu entfernen. Dieser Fall tritt beispielsweise ein bei einem Werbegutschein in einem Warenkorb, der ausschließlich nicht werbegutscheinfähige Produkte enthält, oder bei einem kategorieabhängigen Gutschein, wenn kein Produkt aus dieser Kategorie im Warenkorb liegt. In manchen Fällen ist die ausdrückliche Löschung durch den Kunden trotzdem sinnvoll, etwa wenn der Gutschein ein Produkt in den Warenkorb steuert. Dann soll der Kunde bemerken, dass er dieses Produkt nicht bekommt. Schritt 1: Ergänzen Sie auf der Seite mit der Gutscheineingabe den Grund 14 in MSG-Voucher_error, siehe die Tabelle oben. Schritt 2: Setzen Sie in der shop.config im Abschnitt <Voucher-Txt> den folgenden Eintrag.

<Voucher-Txt>
   PreventOrdersWithVoucherNotApplicable = yes
</Voucher-Txt>

Die beiden Schritte gehören zusammen. Setzen Sie den Eintrag, ohne Grund 14 zu hinterlegen, wird die Bestellung blockiert und der Kunde sieht keinen Hinweis, warum es nicht weitergeht.

Anpassung bei Gutscheineingabe auf der Bestellübersichtsseite und Mindestbestellwert

Diese Ergänzung brauchen Sie, wenn beides auf Ihren Shop zutrifft:

Die Gutscheinnummer wird ausschließlich auf der Bestellübersichtsseite ws_place_order.htm eingegeben.
Der Gutscheinrabatt auf Positionsebene wird beim Mindestbestellwert berücksichtigt, gesteuert über MinimumOrder-ConsiderVoucherDiscount-Allow im Abschnitt <OrderConditions>.

Die Berücksichtigung ist die Voreinstellung. Nur ein ausdrückliches MinimumOrder-ConsiderVoucherDiscount-Allow = no schaltet sie ab und rechnet den Gutscheinrabatt auf Positionsebene wieder auf die Berechnungsgrundlage auf. Senkt der Gutschein den Warenwert unter den Mindestbestellwert, führt der Shop den Kunden zurück auf die Warenkorbseite. Dort muss er den Gutschein löschen können, sonst sitzt er fest: Eingeben kann er ihn nur auf der Bestellübersichtsseite, dorthin kommt er aber nicht mehr. Ergänzen Sie deshalb auf der Warenkorbseite ws_basket.htm den folgenden Block.

{MSG-Basket_Notify}
   {ST-Voucher_checked}
      {VOUCHER-Number}
         <input autocomplete="off" type="text" value="~VOUCHER-Number~" disabled>
         <input type="submit" name="~BT-Voucher_delete~" value="Gutschein entfernen">
      {/VOUCHER-Number}
   {/ST-Voucher_checked}
{/MSG-Basket_Notify}

Das Feld ist bewusst auf disabled gesetzt. Der Kunde soll die Nummer sehen und einordnen können, aber auf dieser Seite nicht ändern, weil die Eingabe hier keine Wirkung hätte. Referenz: MSG-Basket_Notify · ST-Voucher_checked · VOUCHER-Number · BT-Voucher_delete

​Wie das Einlösen im Shop abläuft

​Gutscheinnummern per Link übergeben

​Gutschein im stationären Handel einlösen

​Die Gutschein-Eingabe integrieren

​Schritt 1: Freischaltung

​Schritt 2: Einstellungen in der Shopkonfiguration

​Schritt 3: Eingabefeld und Buttons platzieren

​Schritt 4: Meldungen platzieren

​Schritt 5: Link zum Entfernen platzieren (optional)

​Bestellabschluss mit nicht anwendbaren Gutscheinen unterbinden

​Anpassung bei Gutscheineingabe auf der Bestellübersichtsseite und Mindestbestellwert

​Verwandte Themen

Wie das Einlösen im Shop abläuft

Gutscheinnummern per Link übergeben

Gutschein im stationären Handel einlösen

Die Gutschein-Eingabe integrieren

Schritt 1: Freischaltung

Schritt 2: Einstellungen in der Shopkonfiguration

Schritt 3: Eingabefeld und Buttons platzieren

Schritt 4: Meldungen platzieren

Schritt 5: Link zum Entfernen platzieren (optional)

Bestellabschluss mit nicht anwendbaren Gutscheinen unterbinden

Anpassung bei Gutscheineingabe auf der Bestellübersichtsseite und Mindestbestellwert

Verwandte Themen