Kaufgutscheine zum Ausdrucken - WEBSALE Dokumentation

Ein Kaufgutschein ist ein Gutschein, den der Kunde im Shop kauft, meist um ihn zu verschenken. Sein größter Vorteil ist das Tempo: Der Käufer lädt ihn unmittelbar nach der Bezahlung herunter und druckt ihn aus, was ihn zum brauchbaren Last-Minute-Geschenk macht. Technisch ist ein Kaufgutschein ein ganz gewöhnliches Produkt. Er wird in den Warenkorb gelegt, durchläuft den normalen Bestellvorgang und wird wie jedes andere Produkt bezahlt. Das Besondere passiert im Hintergrund.

Wie der Ablauf aussieht

Schritt	Was geschieht
Der Kunde legt das Gutscheinprodukt in den Warenkorb	Der Shop erzeugt eine Gutscheinnummer oder entnimmt sie einem vorher angelegten Pool
Der Kunde bezahlt	Die Gutscheinnummer wird ihm sofort angezeigt
Der Kunde lädt den Gutschein herunter	Je Gutscheinnummer entsteht aus einem eigenen Template eine PDF-Datei mit Nummer, Betrag und Gültigkeit

Weil der Käufer die Nummer unmittelbar nach der Bezahlung sieht und sofort einlösen kann, lassen sich Kaufgutscheine an sichere Zahlungsarten knüpfen. Wie das eingestellt wird, steht in Schritt 5. Ändert der Kunde nach dem Legen in den Warenkorb noch den Wert, beispielsweise über eine andere Variante, zieht der Shop die Nummern neu. Die Nummer, die am Ende auf dem Gutschein steht, ist deshalb erst mit der Bestellung endgültig. Anwendungsbeispiel: Kaufgutscheine zum Ausdrucken mit mehreren Motiven anbieten

Die Integration

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. Kommen die Gutscheine aus einem externen System und liegen deshalb nicht im WEBSALE-Format vor, ergänzen Sie im Abschnitt <Voucher-Txt> der shop.config den Eintrag ExternalVouchers-Allow = yes.

Schritt 2: Gutscheineingabe integrieren

Bietet Ihr Shop noch gar keine Gutscheine an, fehlt die Eingabemöglichkeit. Ohne sie kann niemand den gekauften Gutschein später einlösen. Wegweiser: Gutschein-Eingabe vorsehen

Schritt 3: Die Kaufgutscheine als Produkte anlegen

Kaufgutscheine werden wie jedes andere Produkt angelegt. Zusätzlich brauchen sie das Produktfeld InstantVoucherProduct, das aus vier Angaben besteht. Alle vier stehen hintereinander in einem Feld und werden von <g> umschlossen.

<g><1>Gutscheinprodukt y/n</1><2>ChargenID</2><3>Vorlagenwert überschreiben y/n</3><4>Nummer neu generieren y/n</4></g>

Position	Bedeutung	Werte
`<1>`	ist dieses Produkt ein Gutscheinprodukt	`y` aktiv. Jeder andere Wert bedeutet inaktiv, und die restlichen drei Angaben werden nicht ausgewertet
`<2>`	die ChargenID, zu der die Gutscheine gehören	der Name der Charge
`<3>`	woher der Gutscheinwert kommt	`y` der Produktpreis ist der Gutscheinwert und überschreibt den Wert aus Vorlage oder Pool. Jeder andere Wert belässt es beim Wert aus Vorlage oder Pool
`<4>`	woher die Nummer kommt	`y` der Shop generiert eine neue Nummer. Jeder andere Wert entnimmt sie dem Pool

<g><1>y</1><2>Kaufgutscheine</2><3>y</3><4>y</4></g>

Die Werte werden auf y geprüft, nicht auf n. Ein Tippfehler oder ein leeres Feld an Position 1 macht das Produkt zu einem gewöhnlichen Artikel, der ohne Gutschein verkauft wird. Der Shop meldet das nicht.

Für die Wertabstufungen werden in aller Regel Varianten verwendet. Eine Variante “Gutscheinwert” mit den Stufen 10, 20, 50, 100, 200 und 500 Euro ist der übliche Aufbau. In Verbindung mit <3> gleich y ergibt sich der Gutscheinwert dann unmittelbar aus der gewählten Variante.

Schritt 4: Gutscheinnummern bereitstellen

Die Nummern kommen aus einer von zwei Quellen. Welche es ist, entscheidet Position 4 im Produktfeld.

Position 4	Quelle	Was Sie vorbereiten
`y`	Der Shop generiert die Nummer neu	eine Gutscheinvorlage im Gutschein-Generator des Online-Servicebereichs
alles andere	Der Shop entnimmt sie einem Pool	Import eines Gutscheinnummern-Pools aus Ihrem Warenwirtschafts- oder ERP-System

In beiden Fällen muss jedem Gutschein eine ChargenID zugewiesen sein, denn genau diese ID tragen Sie an Position 2 des Produktfelds ein. Ohne passende Charge findet der Shop keine Nummern. Haben Sie an Position 3 festgelegt, dass der Produktpreis den Gutscheinwert bestimmt, überschreibt der Shop zwei Angaben, unabhängig von der Quelle:

Die hinterlegte Währung wird durch die Währung des Subshops ersetzt.
Der Gutscheinwert aus Vorlage oder Pool wird durch den Produktpreis ersetzt.

Beim Pool muss Ihr Vorsystem dafür sorgen, dass immer genügend Nummern bereitstehen. Sind keine mehr da, kann das Gutscheinprodukt nicht gekauft werden. Die Prüfung findet im Regelfall erst bei der Bestellaufgabe statt und nicht schon beim Legen in den Warenkorb. Der Kunde durchläuft also den gesamten Bestellvorgang, bevor er die Fehlermeldung sieht. Überwachen Sie den Füllstand des Pools deshalb aktiv, statt sich auf die Meldung zu verlassen.

Das Format der Importdatei ist in einer eigenen Dokumentation beschrieben, die Sie bei der WEBSALE AG anfordern können. Wegweiser: Gutscheine anlegen oder importieren

Schritt 5: Zahlungsarten festlegen

Weil der Käufer die Gutscheinnummer sofort nach der Bezahlung sieht und sie unmittelbar einlösen kann, sollten Sie Kaufgutscheine nur gegen Online-Bezahlverfahren wie Kreditkarte, PayPal oder Sofortüberweisung abgeben. Bei Rechnung oder Nachnahme hätte der Kunde den Gegenwert bereits in der Hand, bevor das Geld bei Ihnen ist. Die Freigabe legen Sie je Zahlungsart einzeln fest, in der shop.config im jeweiligen Abschnitt <PaymentXXX-Txt>.

<PaymentXXX-Txt>
   InstantVoucherProducts-Allow = yes
</PaymentXXX-Txt>

XXX steht für die jeweilige Zahlungsart, der Abschnitt heißt also beispielsweise <PaymentCreditCard-Txt>. Liegt mindestens ein Kaufgutschein im Warenkorb, bietet der Shop nur noch die Zahlungsarten an, bei denen dieser Eintrag auf yes steht. Referenz: PaymentXXX-Txt

Schritt 6: Kaufgutscheine in den Templates kennzeichnen (optional)

Kaufgutscheine lassen sich gesondert klammern, um sie anders darzustellen als gewöhnliche Produkte, beispielsweise mit einem Hinweis auf den sofortigen Download.

Template	Abschnitt
Produktübersichtsseite `ws_category.htm` und Produktdetailansicht `ws_product.htm`	`PR-InstantVoucherProduct`
Warenkorbseite `ws_basket.htm`	`BASKET-PR-InstantVoucherProduct`

{PR-InstantVoucherProduct}
   Diesen Gutschein erhalten Sie sofort nach der Bezahlung zum Ausdrucken.
{/PR-InstantVoucherProduct}

Referenz: PR-InstantVoucherProduct · BASKET-PR-InstantVoucherProduct

Schritt 7: Gutscheinnummer und Download-Link anzeigen

Die erzeugte Nummer und der Link auf die PDF-Datei lassen sich an drei Stellen ausgeben: auf der Bestelleingangsbestätigungsseite ws_confirm.htm, in der Bestelleingangsbestätigungs-E-Mail und in der Bestellhistorie.

{@BASKET-PR-Data}
   {BASKET-PR-InstantVoucherProduct}
      {BASKET-PR-InstantVoucherProductData}
         {@BASKET-PR-InstantVoucherProductData}
            Gutscheinnummer: ~BASKET-PR-InstantVoucherProductData_VoucherNumber~
            <a href="~WS-Start~~BASKET-PR-InstantVoucherProductData_PDFLinkPart~">Gutschein herunterladen</a>
         {/@BASKET-PR-InstantVoucherProductData}
      {/BASKET-PR-InstantVoucherProductData}
   {/BASKET-PR-InstantVoucherProduct}
{/@BASKET-PR-Data}

Die innere Schleife ist nötig, weil eine Warenkorbposition mehrere Gutscheine enthalten kann. Kauft jemand fünf Gutscheine derselben Sorte, entstehen fünf Nummern und fünf PDF-Dateien in einer einzigen Position. BASKET-PR-InstantVoucherProductData_PDFLinkPart liefert nur den hinteren Teil der Adresse. Davor gehört WS-Start, deshalb stehen die beiden Tags im Beispiel direkt hintereinander. Der Parameter ist verschlüsselt und mit einer Prüfsumme versehen und enthält die Shopkennung, sodass sich fremde Gutscheine darüber nicht abrufen lassen. Referenz: BASKET-PR-Data · BASKET-PR-InstantVoucherProduct · BASKET-PR-InstantVoucherProductData · BASKET-PR-InstantVoucherProductData_VoucherNumber · BASKET-PR-InstantVoucherProductData_PDFLinkPart · WS-Start

Schritt 8: Das Template für den PDF-Download erstellen

Der Gutschein zum Ausdrucken entsteht aus einem eigenen Template. Dafür sind drei Einstellungen nötig.

8.1 Das Template in der Konfiguration zuweisen

<Templates>
   InstantVoucherPDF = ws_instant_voucher.htm   # Template für den PDF-Download des Gutscheins
</Templates>

8.2 Das Template anlegen

Legen Sie das Template unter dem soeben vergebenen Namen in Ihrem Templateverzeichnis an, also beispielsweise unter benutzer/templates, in einem mehrsprachigen Shop im Verzeichnis des jeweiligen Subshops.

Gutschein
Betrag:     ~INSTANTVOUCHER-Amount~ ~INSTANTVOUCHER-CurrencyCode~ ~INSTANTVOUCHER-CurrencySymbol~
Nummer:     ~INSTANTVOUCHER-VoucherNumber~
Gültig bis: ~INSTANTVOUCHER-ValidUntil_day~.~INSTANTVOUCHER-ValidUntil_month~.~INSTANTVOUCHER-ValidUntil_year~

Die Familie INSTANTVOUCHER- umfasst genau diese sieben Tags.

Tag	Inhalt
`INSTANTVOUCHER-Amount`	der Gutscheinbetrag, bereits im Preisformat des Shops
`INSTANTVOUCHER-CurrencyCode`	der Währungscode, beispielsweise `EUR`
`INSTANTVOUCHER-CurrencySymbol`	das Währungssymbol
`INSTANTVOUCHER-VoucherNumber`	die Gutscheinnummer
`INSTANTVOUCHER-ValidUntil_day`	der Tag der Gültigkeit
`INSTANTVOUCHER-ValidUntil_month`	der Monat der Gültigkeit
`INSTANTVOUCHER-ValidUntil_year`	das Jahr der Gültigkeit

Die drei Datumstags bleiben leer, wenn für den Gutschein kein Ablaufdatum hinterlegt ist. Der Satz “Gültig bis: ..” steht dann mit zwei nackten Punkten auf dem ausgedruckten Gutschein. Klammern Sie die Zeile deshalb, beispielsweise über {INSTANTVOUCHER-ValidUntil_year}, damit sie nur bei vorhandenem Datum erscheint.

Für ein Ladengeschäft können Sie die Gutscheinnummer zusätzlich als Barcode auf das Template drucken und an der Kasse einscannen lassen. Den Barcode erzeugt das Tag WS-BarcodeURL als Bild. Referenz: Abschnitt Templates · INSTANTVOUCHER- · WS-BarcodeURL

8.3 Den Dateinamen der PDF-Datei festlegen

<PDFGenerator>
   InstantVoucherPDFFilename = gutschein.pdf
</PDFGenerator>

Dieser Name erscheint im Download-Dialog des Kunden. Ein sprechender Name wie gutschein.pdf ist hier mehr wert als eine technische Bezeichnung, weil die Datei im Downloadordner des Käufers wiederfindbar bleiben soll. Referenz: Abschnitt PDFGenerator

Schritt 9: Die Fehlermeldung hinterlegen

Geht beim Ziehen oder Erzeugen einer Gutscheinnummer etwas schief, braucht der Kunde einen Text. Legen Sie ihn in der shop.config im Abschnitt <NotifyMessages-Txt> ab.

<NotifyMessages-Txt>
   InstantVoucherError = Es ist ein Fehler aufgetreten. Bitte versuchen Sie es erneut oder wenden Sie sich an den Shopbetreiber.
</NotifyMessages-Txt>

Diese Meldung ist der einzige Hinweis, den der Kunde im Fehlerfall bekommt, und sie erscheint typischerweise erst bei der Bestellaufgabe. Ohne hinterlegten Text bricht der Bestellvorgang ohne Erklärung ab.

Referenz: NotifyMessages-Txt

Schritt 10: Download in der Bestellhistorie anbieten

Löscht der Kunde die Bestätigungsmail, hat er ohne diesen Schritt keine Möglichkeit mehr, an seinen Gutschein zu kommen. Ergänzen Sie den Download deshalb auf der Bestellhistorie ws_order_history.htm.

{@OH-S-Item}
   {@OH-S-InstantVoucherProduct}
      <a href="~WS-Start~~OH-P-PDFLinkPart~">Gutschein ausdrucken</a>
      Gutscheinnummer: ~OH-P-Number~
   {/@OH-S-InstantVoucherProduct}
{/@OH-S-Item}

Referenz: OH-S- · OH-P- · WS-Start

Was Sie beachten sollten

Der Kaufgutschein lässt sich nicht als PDF-Anhang an die Bestellbestätigungsmail hängen. Der Kunde erreicht ihn ausschließlich über einen Download-Link, entweder in der Bestelleingangsbestätigung aus Schritt 7 oder in der Bestellhistorie aus Schritt 10. Richten Sie deshalb möglichst beide Wege ein.

Bei Fragen zur Einrichtung wenden Sie sich an das WEBSALE Support-Team.

​Wie der Ablauf aussieht

​Die Integration

​Schritt 1: Freischaltung

​Schritt 2: Gutscheineingabe integrieren

​Schritt 3: Die Kaufgutscheine als Produkte anlegen

​Schritt 4: Gutscheinnummern bereitstellen

​Schritt 5: Zahlungsarten festlegen

​Schritt 6: Kaufgutscheine in den Templates kennzeichnen (optional)

​Schritt 7: Gutscheinnummer und Download-Link anzeigen

​Schritt 8: Das Template für den PDF-Download erstellen

​8.1 Das Template in der Konfiguration zuweisen

​8.2 Das Template anlegen

​8.3 Den Dateinamen der PDF-Datei festlegen

​Schritt 9: Die Fehlermeldung hinterlegen

​Schritt 10: Download in der Bestellhistorie anbieten

​Was Sie beachten sollten

​Verwandte Themen

Wie der Ablauf aussieht

Die Integration

Schritt 1: Freischaltung

Schritt 2: Gutscheineingabe integrieren

Schritt 3: Die Kaufgutscheine als Produkte anlegen

Schritt 4: Gutscheinnummern bereitstellen

Schritt 5: Zahlungsarten festlegen

Schritt 6: Kaufgutscheine in den Templates kennzeichnen (optional)

Schritt 7: Gutscheinnummer und Download-Link anzeigen

Schritt 8: Das Template für den PDF-Download erstellen

8.1 Das Template in der Konfiguration zuweisen

8.2 Das Template anlegen

8.3 Den Dateinamen der PDF-Datei festlegen

Schritt 9: Die Fehlermeldung hinterlegen

Schritt 10: Download in der Bestellhistorie anbieten

Was Sie beachten sollten

Verwandte Themen