Ein META-Gutschein ist ein Sammel-Code, der mehrere einzelne Gutschein-Codes (Sub-Gutscheine) zusammenfasst. Gibt ein Kunde den META-Code ein, werden automatisch alle zugehörigen Sub-Gutscheine eingelöst. Dabei kann immer nur ein META-Gutschein gleichzeitig eingelöst sein.

 

Inhalt

JSON-Datei für META-Gutscheine

Integration

 

 

JSON-Datei für META-Gutscheine

Legen Sie im globalen Konfigurationsverzeichnis (cfg-dir) manuell die Datei meta_vouchers.json an. In dieser Datei werden die META-Gutscheine und die jeweils zugehörigen Sub-Gutscheine definiert.

Für jeden META-Gutschein wird ein eigener Eintrag mit dem vom Kunden einzugebenden META-Code angelegt. Innerhalb dieses Eintrags wird über das Feld vouchers festgelegt, welche Sub-Gutscheincodes beim Einlösen des META-Gutscheins berücksichtigt werden.

Optional kann zusätzlich das Feld showAsBlock gesetzt werden. Damit wird direkt in der JSON-Datei gesteuert, ob die zugehörigen Sub-Gutscheine als gemeinsamer Block behandelt und angezeigt werden. Wird showAsBlock nicht angegeben, gilt automatisch der Wert aus dem Abschnitt <Voucher-Txt> der Shopkonfiguration shop.config.

Beispiel meta_vouchers.json:

{
 "<META-CODE>": {
         "vouchers": ["<SUB-CODE-1>", "<SUB-CODE-2>", ...],
         "showAsBlock": <true|false> 
 },
 ...
}

 

 

Integration

Schritt 1: Freischaltung / Aktivierung

Die Funktion muss nicht freigeschaltet werden und kann jederzeit genutzt werden.

 

Schritt 2: Einstellung in der Shopkonfiguration shop.config vornehmen

Ergänzen Sie den Abschnitt <Voucher-Txt> der Shopkonfiguration shop.config um die Parameter MetaVoucherErrorMode und MetaVoucherShowAsBlock. Mit MetaVoucherErrorMode legen Sie fest, wie mit META-Gutscheinen umgegangen werden soll, wenn einer der enthaltenen Sub-Gutscheine ungültig oder fehlerhaft ist. Mit MetaVoucherShowAsBlock steuern Sie, ob die zugehörigen Sub-Gutscheine im Frontend als gemeinsamer Block dargestellt werden.

<Voucher-Txt>
 ...
 MetaVoucherErrorMode                = reject-all
 MetaVoucherShowAsBlock        = yes
 ...
</Voucher-Txt>

Referenz: Abschnitt Voucher-Txt

 

Schritt 3: Templates der Gutscheineingabe anpassen (optional)

Passen Sie die Templates für die Gutscheineingabe und Gutscheinanzeige so an, dass auch META-Gutscheine und deren Sub-Gutscheine korrekt dargestellt werden können.

 

Die bestehenden Template-Beispiele können dazu um die Tags VOUCHER-MetaCode, VOUCHER-MetaSubCount, VOUCHER-IsFromMeta und VOUCHER-MetaShowAsBlock ergänzt werden. So lässt sich im Template erkennen, ob ein Gutschein aus einem META-Gutschein stammt, welchem META-Gutschein er zugeordnet ist, wie viele Sub-Gutscheine zu diesem META-Gutschein gehören und ob die Block-Anzeige aktiv ist.

 

Auf diese Weise kann die Ausgabe im Frontend gezielt erweitert werden, zum Beispiel um zusätzliche Hinweise bei Sub-Gutscheinen oder eine gesonderte Darstellung, wenn mehrere Gutscheine als gemeinsamer Block angezeigt werden sollen.

Beispiel Warenkorbseite (ws_basket.htm):

...
 
<form action="~FORM-Basket~" method="post"> <!-- und/oder form action="~FORM-PlaceOrder~" -->
 ...
 
 {!VOUCHER-Number}
 
         <!-- wenn keine Gutscheinnummer eingegeben wurde, können die Eingabefelder angezeigt werden -->
 
 {/!VOUCHER-Number}
 
 {VOUCHER-Number}
 
         <!-- Der Käufer hat bereits eine Gutscheinnummer eingegeben bzw. Übergabe per Deep-Link -->
 
         Gutscheinnummer: ~VOUCHER-Number~
         
         ...
 
         {VOUCHER-IsFromMeta}
 
                 Gehört zu META-Gutschein: ~VOUCHER-MetaCode~
 
                {VOUCHER-MetaSubCount}Anzahl Sub-Gutscheine: ~VOUCHER-MetaSubCount~{/VOUCHER-MetaSubCount}
 
                 {VOUCHER-MetaShowAsBlock}
 
                         Dieser Gutschein wird als Teil der META-Gutscheine im "Block" dargestellt und behandelt, d.h. klick auf den Löschen-Button, löscht alle Sub-Gutscheine mit einem Klick.
 
                 {/VOUCHER-MetaShowAsBlock}
 
         {/VOUCHER-IsFromMeta}
 
         <input type="submit" name="~BT-Voucher_delete~" value="Gutschein entfernen">
 
 
         {ST-Voucher_checked}
 
                 {!ST-Voucher_OK}
 
                         <!-- Wenn die Gutscheinnummer bereits geprüft wurde und nicht gültig ist, die fehlerhafte Eingabe hervorheben -->
 
                 {/!ST-Voucher_OK}
 
         {/ST-Voucher_checked}
 
 
 {/VOUCHER-Number}
 
 ...
 
</form>
 
...

Referenz: VOUCHER-MetaCode

Referenz: VOUCHER-MetaSubCount

Referenz: VOUCHER-IsFromMeta
Referenz: VOUCHER-MetaShowAsBlock