Werbemittelkennzeichen

Werbemittelkennzeichen, auch Werbemittelcodes genannt, sind kurze Codes, mit denen sich nachvollziehen lässt, über welches Werbemittel eine Bestellung zustande gekommen ist. Beispiele hierfür sind ein bestimmter Katalog, eine Anzeige oder ein Mailing. Der Code wird an die Produktnummer angehängt, beispielsweise 123456-09 - dabei steht 123456 für die Produktnummer und 09 für das Werbemittelkennzeichen. Die vollständigen technischen Details je Ebene (Template-Modul, Konfiguration, REST- und Storefront-API) stehen auf den unter Weiterführende Links verlinkten Detailseiten.

Die Funktion ist standardmäßig ausgeschaltet. Solange sie nicht aktiviert ist, verhält sich der Shop unverändert: keine zusätzlichen Eingabefelder, keine zusätzlichen Anzeigen, nichts wird gespeichert.

So verhält sich der Shop

Sobald diese Funktion aktiviert ist, kann zu einem Produkt neben der Produktnummer auch ein Werbemittelkennzeichen erfasst werden. Welche Codes für ein Produkt überhaupt zulässig sind, legt die Produktpflege fest. Wenn jemand einen Code angibt, wird folgende Logik angewendet:

Gültiger Code → der Code wird übernommen und am Warenkorbposten gespeichert.
Unbekannter oder kein Code → es greift der konfigurierte Standardcode. Ist keiner hinterlegt, bleibt der Posten ohne Kennzeichen.

Die Prüfung erfolgt zeichengenau und unter Beachtung der Groß-/Kleinschreibung. So sind beispielsweise DA und da nicht dasselbe. Ein einmalig erkannter Code wird als sitzungsweites Werbemittelkennzeichen gespeichert - ein einzelner Code, mit dem der Besucher aktuell unterwegs ist. Jeder danach hinzugefügte Artikel übernimmt diesen, sofern er für das jeweilige Produkt gültig ist. Andernfalls wird der Standardcode verwendet. Eine erneute Eingabe des Codes ist nicht erforderlich.

Der Code bleibt erhalten, wenn ein Artikel zwischendurch aus dem Warenkorb entfernt wird. Mit Abschluss der Bestellung wird der Code gelöscht. Ein neu eingegebener Code ersetzt den bisherigen als aktuelles Sitzungskennzeichen. Außerdem wird das Werbemittelkennzeichen mit der Bestellung gespeichert und steht damit in der Bestellauswertung als eigene Information zur Verfügung.

Wo ein Code erfasst werden kann

Direktlink: Über ?itemNumber=<Produktnummer>&insert=<Code> lässt sich eine Produktdetailseite mit hinterlegtem Werbemittelkennzeichen direkt aufrufen - ideal für Links aus Katalogen oder Anzeigen. Der Werbemittelparameter funktioniert auch in Kombination mit der Produkt-ID: ?productId=<ProduktID>&insert=<Code>.
Direktbestellung: Auf der Direktbestellseite gibt es neben den Feldern für die Produktnummer ein eigenes Feld für das Werbemittelkennzeichen.
Warenkorb (Schnittstelle): Beim Hinzufügen oder Ändern eines Postens kann der Code direkt mitgegeben werden - siehe Storefront-API Warenkorb.

Direktlinks über die Produktnummer ohne Werbemittelkennzeichen (?itemNumber=<Produktnummer>) sind jederzeit verfügbar, auch wenn Werbemittelkennzeichen deaktiviert sind.

Set-Artikel und Varianten

Bei Set-Artikeln wird der Code sowohl für die Hauptposition als auch für die enthaltenen Unterartikel aufgelöst. Jeder Unterartikel prüft den Code dabei gegen seine eigenen gültigen Codes (sonst greift der Standardcode) - genauso wie bei einem einzeln hinzugefügten Artikel. Bei Varianten werden die zulässigen Codes auf Ebene des Hauptprodukts gepflegt und gelten für dessen Varianten gleichermaßen. Das sitzungsweite Kennzeichen wird beim Hinzufügen einer Variante gegen deren gültige Codes geprüft, genauso wie bei jedem anderen Artikel.

Module

Für die Ausgabe des Werbemittelkennzeichens im Template werden diese Module verwendet:

$wsConfig - liefert über $wsConfig.inserts die aktuellen Einstellungen (aktiv, Trennzeichen, Position, Standardcode) und wird benötigt, um Ausgaben nur bei aktiver Funktion anzuzeigen.
$wsBasket - liefert je Warenkorbposition das Kennzeichen über $item.insert und die fertige Anzeige über $item.itemNumberWithInsert.

Die Erfassung eines Codes (Direktlink, Direktbestellung, Warenkorb-Schnittstelle) benötigt kein eigenes Modul - sie geschieht über URL-Parameter, das Direktbestellformular oder die Storefront-API.

Einrichtung

Konfiguration

Die Einstellungen liegen im Konfigurationsbereich unter Inhalte im Block Werbemittelkennzeichen (content.inserts):

Einstellung	Bedeutung	Standard
`enabled`	Schaltet die gesamte Funktion ein bzw. aus.	aus
`defaultInsertCode`	Wird verwendet, wenn kein oder ein ungültiger Code erfasst wurde. Leer lassen, wenn dann gar kein Kennzeichen gesetzt werden soll.	leer
`separator`	Zeichen zwischen Produktnummer und Code, beispielsweise `-`.	`-`
`position`	Steht der Code hinter der Produktnummer (`123456-09`) oder davor (`09-123456`).	dahinter

Solange enabled deaktiviert ist, bleibt die Funktion im gesamten Shop wirkungslos - unabhängig davon, wie die einzelnen Produkte gepflegt sind.

Hinweis zu defaultInsertCode: Der Standardcode greift produktübergreifend für jede Eingabe, die nicht zu einem gültigen Code aufgelöst werden kann. Wer den Code auf einen festen Wert setzt, sollte bedenken, dass dieser Wert dann auch für Posten verwendet werden kann, für die eigentlich kein Werbemittelkennzeichen vorgesehen ist. Im Zweifel sollten Sie den Wert leer lassen.

Zulässige Codes am Produkt

Über das Feld “Gültige Werbemittelkennzeichen” (validInsertCodes ) wird pro Produkt festgelegt, welche Codes für dieses Produkt erlaubt sind. Es handelt sich um eine Liste, in der jeder gültige Code einmal eingetragen ist. Folgende Voraussetzungen gelten für das anlegen eines Codes:

Jeder Eintrag darf maximal 16 Zeichen lang sein.
Die Codes sind case-sensitiv (beispielsweise istDA nicht gleich da).
Das Feld wird auf Ebene des Hauptprodukts gepflegt und gilt für dessen Varianten mit.
Ist die Liste leer, kann für dieses Produkt kein Code übernommen werden (es greift höchstens der Standardcode, sofern gesetzt).

Einrichtung (einmalig pro Shop): Damit der Shop das Feld überhaupt findet, muss es in der Konfiguration unter usedFields.products zugeordnet sein: validInsertCodes: content.customProductField.validInsertCodes. Fehlt diese Zuordnung, kann der Shop die zulässigen Codes eines Produkts nicht ermitteln und jeder Posten erhält den Standardcode ohne Fehlermeldung. Die Zuordnung ist damit Voraussetzung dafür, dass die produktspezifischen Codes wirken (nicht nur die Felddefinition selbst).

Anzeige im Shop

Das Kennzeichen erscheint im Warenkorb, in der Bestellübersicht, in der Bestätigungs-E-Mail, im Bestell-PDF und in der Bestellhistorie als Teil der Artikelnummer (beispielsweise 123456-09 ) - in der konfigurierten Reihenfolge und mit dem konfigurierten Trennzeichen. Auf der Direktbestellseite wird das Eingabefeld für das Werbemittelkennzeichen entsprechend der Konfiguration vor oder hinter den Feldern der Produktnummer platziert. Wird ein unbekannter Code eingegeben, verwirft der Shop diesen und greift, sofern eingerichtet, auf den Standardwert zurück. Dadurch wird die Bestellung nie blockiert.

Beispiele

Artikelnummer mit Werbemittelkennzeichen ausgeben

Im Warenkorb (und analog in der Bestellübersicht, der E-Mail und dem PDF) genügt es itemNumberWithInsert als Artikelnummer auszugeben. Die Reihenfolge und das Trennzeichen sind darin bereits berücksichtigt. Ist kein Code gesetzt, enthält das Feld die reine Produktnummer.

{{ foreach $item in $wsBasket.items }}
  <p>Art.-Nr.: {{= $item.itemNumberWithInsert }}</p>
  <p>Produktname: {{= $item.product.name }}</p>
{{ /foreach }}

Ergebnis
Jede Position zeigt ihre Artikelnummer inklusive Werbemittelkennzeichen, sofern eines erfasst wurde. Andernfalls wird die reine Produktnummer angezeigt.