Werbemittelkennzeichen

​

Voraussetzungen

1. Die Funktion ist aktiviert. In der Konfiguration muss content.inserts.enabled auf true stehen. Solange sie aus ist, wird kein Code erfasst, aufgelöst oder angezeigt.
2. Die Feldzuordnung ist eingerichtet (einmalig pro Shop). Der Shop muss wissen, welches Produktfeld die gültigen Codes enthält. Diese Zuordnung wird in content.usedFields.products.validInsertCodes hinterlegt. Fehlt sie, findet der Shop die am Produkt gepflegten Codes nicht und behandelt jedes Produkt so, als hätte es keine gültigen Codes.
3. Am Produkt sind gültige Codes gepflegt. Erst wenn ein Produkt im Feld validInsertCodes konkrete Codes trägt, kann für dieses Produkt ein Code übernommen werden. Ist die Liste leer, greift der Standardcode (defaultInsertCode), sofern einer konfiguriert ist.

​

Begriffe und technische Namen auf einen Blick

​

Wie der Shop ein Werbemittelkennzeichen ermittelt

1. Ein gültiger Code wurde angegeben → Der Code wird für das Produkt übernommen.
2. Kein Code wurde angegeben → Der Shop übernimmt den Code, den er sich zuvor für genau dieses Produkt gemerkt hat (siehe Gemerktes Werbemittelkennzeichen je Produkt), sofern er für das Produkt gültig ist. Bei Varianten zählt die konkrete Variante.
3. Andernfalls → Es greift der in der Konfiguration hinterlegte Standardcode (defaultInsertCode). Ist keiner hinterlegt, bleibt die Position ohne Kennzeichen.

​

Gemerktes Werbemittelkennzeichen je Produkt

• Jede Warenkorbposition behält ihr eigenes Kennzeichen. Deshalb können im Warenkorb mehrere Produkte mit unterschiedlichen Codes liegen.
• Das gemerkte Kennzeichen bleibt während der Navigation für dieses Produkt erhalten, beispielsweise auf der Produktdetailseite, beim Wechsel der Variante und im Warenkorb. Das gilt auch, wenn das Produkt zwischenzeitlich aus dem Warenkorb entfernt wird.
• Zwei Varianten desselben Produkts behalten jeweils ihr eigenes Kennzeichen.
• Wenn dasselbe Produkt in derselben Variante erneut hinzugefügt wird, entsteht keine zweite Position. Die Mengen werden summiert. Wenn das erneute Hinzufügen jedoch einen Code mitbringt, erhält die Position den neu ermittelten Code. Ohne Code behält die Position ihren bisherigen.
• Jeder erkannte Code wird gemerkt, auch ein ungültiger. Er ersetzt den zuvor gemerkten Code dieses Produkts. Beim nächsten Hinzufügen ohne Code wird dann der Standardcode verwendet, sofern einer konfiguriert ist.
• Die gemerkten Kennzeichen gelten nur für die laufende Sitzung. Nach Abschluss der Bestellung beginnt eine neue Sitzung, sodass sie entfallen. Zudem setzt der Shop sie zurück, wenn er den Warenkorb beim Abmelden oder Wechseln des Kundenkontos leert.

​

Was bedeutet „gültiger Code”

​

Speicherung in der Bestellung

​

Wo ein Code erfasst werden kann

• Über die URL: Ein Werbemittelkennzeichen lässt sich per URL-Parameter insert an einen Produktaufruf anhängen. Das eignet sich für Links aus Katalogen, Anzeigen oder Mailings. Dafür gibt es zwei unabhängige Wege:
  • an einer technischen View-URL über die Produkt-ID: ?view=Product&productId=<ProduktId>&insert=<Code>
  • an einer SEO-URL des Produkts: /buntes-t-shirt?insert=<Code>
• Direktbestellung: Der Kunde gibt die Artikelnummer zusammen mit dem Werbemittelkennzeichen in ein einziges Feld ein, so wie sie im Katalog abgedruckt ist, beispielsweise 123456/AB. Der Shop trennt den Code selbst ab. Wie das funktioniert, steht unter Werbemittelkennzeichen in der Direktbestellung erfassen.
• Warenkorb (Schnittstelle): Beim Hinzufügen oder Ändern eines Postens kann der Code direkt mitgegeben werden, siehe Storefront-API Warenkorb.

​

Praxisbeispiel: von der Anzeige bis zur Bestellung

​

Sonderfälle

​

Einrichtung

​

Konfiguration

​

Produktfeld anlegen

​

Feldzuordnung einrichten

{
  "products": {
    "validInsertCodes": "content.customProductField.validInsertCodes"
  }
}

​

Zulässige Codes am Produkt

• Jeder Eintrag darf maximal 16 Zeichen lang sein.
• Jeder Code ist ein eigener Listeneintrag. Die Codes werden nicht durch Kommas oder andere Trennzeichen in einem Feld aneinandergereiht.
• Die Codes sind case-sensitiv (beispielsweise ist DA 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).

{{= $cProduct.custom.validInsertCodes | join(", ") }}

​

Anzeige im Shop

​

Module

• $wsInserts liefert das je Produkt gemerkte Kennzeichen über $wsInserts.byProduct sowie die Einstellungen (aktiv, Trennzeichen, Position, Standardcode). Damit lässt sich das Kennzeichen überall anzeigen, wo ein Produkt dargestellt wird.
• $wsBasket liefert je Warenkorbposition das Kennzeichen über $item.insert und die Artikelnummer der Position über $item.itemNumber.
• $wsConfig liefert über $wsConfig.inserts dieselben Einstellungen wie $wsInserts. Das Objekt bleibt weiterhin verfügbar.

​

Beispiele

​

Artikelnummer mit Werbemittelkennzeichen ausgeben

{{ foreach $item in $wsBasket.items }}
  <p>Art.-Nr.: {{ include "components/itemNumberWithInsert.htm" with $cNumber = $item.itemNumber, $cCode = $item.insert }}</p>
  <p>Produktname: {{= $item.product.name }}</p>
{{ /foreach }}

​

Gemerktes Werbemittelkennzeichen am Produkt anzeigen

{{ if $wsInserts.enabled and $wsInserts.byProduct[$cProduct.id] }}
  <p>Art.-Nr.: {{ include "components/itemNumberWithInsert.htm" with $cNumber = $cProduct.itemNumber, $cCode = $wsInserts.byProduct[$cProduct.id] }}</p>
{{ /if }}

​

Werbemittelkennzeichen als eigenes Feld ausgeben

{{ if $wsConfig.inserts.enabled }}
  {{ foreach $item in $wsBasket.items }}
    {{ if $item.insert }}
      <p>Werbemittelcode: {{= $item.insert }}</p>
    {{ /if }}
  {{ /foreach }}
{{ /if }}

​

Werbemittelkennzeichen in der Direktbestellung erfassen

1. Er prüft, ob die gesamte Eingabe eine gültige Artikelnummer ist. Dann trennt er nichts ab. So wird eine echte Artikelnummer, die das Trennzeichen zufällig enthält, nicht zerschnitten.
2. Andernfalls trennt er den Code ab und prüft die verbleibende Nummer. Steht der Code dahinter, trennt der Shop am letzten Trennzeichen. Steht er davor, trennt der Shop am ersten Trennzeichen. Aus der Nummer 123-456-09 mit dem Trennzeichen „-” wird somit die Nummer 123-456 mit dem Code 09.
3. Der abgetrennte Code wird gegen die gültigen Codes des gefundenen Produkts geprüft, wie unter Wie der Shop ein Werbemittelkennzeichen ermittelt beschrieben.

<input type="text"
       name="id"
       class="form-control"
       placeholder="Artikelnummer{{ if $wsInserts.enabled }} mit Werbemittelkennzeichen{{ /if }}"
       ...>

​

Bestellhistorie

​

Weiterführende Links

• $wsInserts: je Produkt gemerktes Kennzeichen über $wsInserts.byProduct sowie die Einstellungen (aktiv, Trennzeichen, Position, Standardcode).
• $wsConfig: Einstellungen über $wsConfig.inserts (aktiv, Trennzeichen, Position, Standardcode).
• $wsBasket: Ausgabe je Position über $item.insert und $item.itemNumber.
• $wsViews: Erzeugung von View-URLs (url(), viewUrl()), an die sich der insert-Parameter anhängen lässt.
• content - Katalog: Konfigurationsblock content.inserts und die zwingende Feldzuordnung usedFields.products.
• API-Referenz Produkte: Pflege der zulässigen Codes je Produkt (custom.validInsertCodes). Setzt die Feldzuordnung usedFields.products voraus (siehe Voraussetzungen).
• API-Referenz Konfiguration: Pflege des Konfigurationsblocks content.inserts über die Konfigurationsknoten-Endpunkte.
• Storefront-API Warenkorb: Setzen und Auslesen des Kennzeichens über das insert-Feld sowie GET /api/v1/config/inserts.