Über die benutzerdefinierten Abschnitte (auch custom_elements genannt) kann auf einem Beleg zusätzlicher, individuell definierter Inhalt hinzugefügt werden. Das ist besonders praktisch, um individuelle Elemente für bestimmte Kundinnen und Kunden hinzuzufügen, oder aber um Kundinnen und Kunden über Aktuelles zu informieren, wie etwa über den bevorstehenden Sommer-Sale.
Es gibt mehrere Typen dieser benutzerdefinierten Abschnitte:
- TEXT
Details zum benutzerdefinierten Abschnitt TEXT und wie dieser zu verwenden ist finden Sie in folgendem Artikel.
- IMAGE
Details zum benutzerdefinierten Abschnitt IMAGE und wie dieser zu verwenden ist finden Sie in folgendem Artikel. - QR_CODE
Details zum benutzerdefinierten Abschnitt QR_CODE und wie dieser zu verwenden ist finden Sie in folgendem Artikel. - BAR_CODE
Details zum benutzerdefinierten Abschnitt BAR_CODE und wie dieser zu verwenden ist finden Sie in folgendem Artikel.
Die Platzierung der benutzerdefinierten Abschnitte am Beleg kann über die Parameter orientation und position definiert werden, wobei sich position auf den nächstgelegenen Belegabschnitt bezieht und orientation die relative Ausrichtung zum Belegabschnitt angibt.
Wie können benutzerdefinierte Abschnitte hinzugefügt werden?
Diese Abschnitte können individuell am Beleg hinzugefügt werden, das ist besonders praktisch für individuelle, einmalig verwendete Nachrichten. Einmalige benutzerdefinierte Abschnitte können beim Erstellen eines Belegs direkt über den API Aufruf (schema.ekabs_v0.custom_elements) hinzugefügt werden.
Für generische Inhalte können benutzerdefinierte Abschnitte für eine bestimmte Dauer auch als Standard eingestellt werden. Dies kann sowohl über die API, als auch über das User Interface des merchant dashboard erfolgen. Wir empfehlen die Händler in ihre Organisationen im Dashboard als Mitwirkende einzuladen, so können sie die benutzerdefinierten Abschnitt unabhängig vom Kassenhersteller festlegen.
Wie kann ein benutzerdefinierter Abschnitt über die API hinzugefügt werden?
- Auswahl des gewünschten Abschnittes: TEXT, IMAGE, QR_CODE, oder BAR_CODE
- Erstellen einer Liste an CustomElements Objekten mit folgendem Inhalt der Objekte:
{
"alignment": "TEXT",
"content": CustomElementContent | CustomMediaContent,
"orientation": "BEFORE",
"position": "HEAD",
} - Im Feld content kann entweder das Objekt CustomElementContent oder das Objekt CustomMediaContent gewählt werden - mit folgendem Inhalt:
CustomElementContent {
"data": "string",
"encoding": "CODE128",
"type": "BAR_CODE"
}
CustomMediaContent {
"alt_text": "string",
"label": "string",
"label_alignment": "ABOVE",
"media_id": "00000000-0000-0000-0000-000000000000",
"media_location": "string",
"type": "IMAGE"
} - Details zum Erstellen des benutzerdefinierten Abschnittes IMAGE finden Sie in folgendem Artikel.
- Fügen Sie das erstellte Objekt zur Liste in schema.ekabs_v0.custom_elements hinzu.
- Erstellen Sie den Beleg über den CreateReceipt Endpunkt.
Wie können benutzerdefinierte Abschnitte über das Dashboard hinzugefügt werden?
1. Wählen Sie Sections im Receipt Builder in der Navigationsleiste auf der linken Seite.
2. Fügen Sie einen benutzerdefinierten Abschnitt hinzu indem Sie auf das '+' auf der rechten Seite klicken.
3. Der benutzerdefinierte Abschnitt des gewählten Typs wird in der durch die Voreinstellungen definierten Position am Beleg hinzugefügt.
4. Konfigurieren Sie den benutzerdefinierten Abschnitt im Editor auf der rechten Seite des Bildschirms, indem Sie z.B. ein Bild hochladen.
5. Klicken Sie rechts oben auf Apply um die Änderungen zu speichern und zu übernehmen. Hinweis: Diese Änderungen müssen zweimal übernommen werden - das erste Mal, um die Änderungen des benutzerdefinierten Abschnitts vorzunehmen und ein zweites Mal, um den eben konfigurierten benutzerdefinierten Abschnitt als Voreinstellung für Ihre Belege zu übernehmen.