Template-Objekt „Bestellung“
- Stefan Bleilevens
Diese Dokumentation beschreibt die Variablen, die im Template-Objekt „Bestellung“ zur Verfügung stehen. Diese Variable enthält relevante Informationen zu einer Bestellung.
Der technische Name dieses Objekts ist Printlounge\DataObject\Template\TemplateOrder.
Für alle Codebeispiele in dieser Dokumentation wird eine Variable mit dem Namen $order verwendet. Je nach verwendetem Template kann dieser Variablenname jedoch abweichen.
Alle Codebeispiele sind in Smarty-Syntax geschrieben, so dass alle Variablen in geschweiften Klammern ausgegeben oder mit Befehlen und Abfragen verknüpft werden können.
Variablen in diesem Datenobjekt
Das Datenobjekt „Bestellung“ enthält folgende Variablen:
Variable | Beschreibung und Verwendung |
|---|---|
bankAccount
| Bankverbindungsdaten Enthält Daten der Bankverbindung, die von einem Shop-Benutzer beim Abschluss der Bestellung angegeben worden sind. Codebeispiel: {if $order->bankAccount}
{$order->bankAccount->…}
{/if}Das Objekt stellt weitere Variablen bereit, welche unter Template-Objekt „Bankverbindung“ dokumentiert sind. Tipp: Bei der Verwendung sollte mit einer |
barcode | Barcode-Daten Codebeispiel: {$order->barcode} |
budgetBefore | Budgetwert vor Bestellabschluss Verfügbares Budget des Benutzers (oder der Benutzergruppe) vor Abschluss der Bestellung. Codebeispiel zur Verwendung {$order->budgetBefore} |
budgetBooking | Verwendeter / Gebuchter Budgetwert für diese Bestellung Der Budgetwert, der für diese Bestellung berechnet und genutzt worden ist. Codebeispiel zur Verwendung |
budgetBookingAfter | Budgetwert nach Bestellabschluss Verfügbares Budget für den Benutzer (oder die Benutzergruppe) nach Abschluss der Bestellung. Codebeispiel zur Verwendung |
budgetBookingInCent | Verwendeter / Gebuchter Budgetwert in Cent Codebeispiel zur Verwendung |
costCenter | Kostenstelle aus der Lieferadresse Übergreifende Kostenstelle aus der Lieferadresse, die für die gesamte Bestellung angegeben worden ist. Gegebenenfalls wurde für einzelne Bestellpositionen eine andere Angabe (bspw. innerhalb einer Bestellposition) vorgenommen. Codebeispiel zur Verwendung |
customFields
| Freifelder im Warenkorb Wichtig: Diese Variable muss mit einer Schleife ( Codebeispiel zur Verwendung Das Objekt innerhalb der Schleife stellt weitere Variablen bereit, welche unter Template-Objekt „Zusatzfeld (Bestellung)“ dokumentiert sind. |
customFieldsByName
| Freifelder im Warenkorb (strukturiert nach Name) Enthält dieselben Objekte wie customFields, jedoch wird der Name des jeweiligen Freifelds als Array-Key genutzt. So ist bspw. ein direkter Zugriff auf ein bestimmtes Freifeld über den Namen möglich, ohne alle Angaben in einer Schleife zu durchlaufen. Codebeispiel zur Verwendung Das Objekt innerhalb der Schleife stellt weitere Variablen bereit, welche unter Template-Objekt „Zusatzfeld (Bestellung)“ dokumentiert sind. |
deliverDate
| Liefertermin Der Liefertermin aus der Bestellung, welcher für die gesamte Bestellung angegeben oder berechnet worden ist. Dieser Termin kann bspw. aus der Liefer- und Produktionszeit des verknüpften Artikels oder anderen Bestellangaben automatisch berechnet worden sein. Sollten keine Einstellungen für den Liefertermin vorgenommen worden sein, wurde diese Information automatisch berechnet und kann – theoretisch – auch dem Bestelldatum entsprechen. Codebeispiel zur Verwendung |
deliveryAddress
| Lieferanschrift / Lieferadresse Die angegebene Lieferadresse der Bestellung, welche von einem Shop-Benutzer im Warenkorb angegeben worden ist. Diese Angabe kann über die Administration nachträglich verändert, oder von einem externen Prozess hinterlegt worden sei (bspw. SSO / OCI / REST-API / SAP / …). Codebeispiel zur Verwendung Das Objekt stellt weitere Variablen bereit, welche unter Template-Objekt „Adressdaten“ dokumentiert sind. |
description | Beschreibung / Details Codebeispiel zur Verwendung |
externalOrderCode | Externer Bestellcode Codebeispiel zur Verwendung Dieses Codebeispiel erzeugt folgende Ausgabe: LP-EXTERNAL-1242922021 |
freeFields
| Freifelder im Warenkorb Objektsammlung aller Freifelder im Warenkorb der Bestellung. Codebeispiel zur Verwendung Das Objekt innerhalb der Schleife stellt weitere Variablen bereit, welche unter Template-Objekt „Freifeld (Bestellung)“ dokumentiert sind. |
id | ID der Bestellung Die einzigartige ID einer Bestellung, über der diese Bestellung eindeutig identifiziert werden kann. Diese ID wird automatische bei der Anlage der Bestellung automatisch von der Software vergeben und kann nicht verändert werden. Codebeispiel zur Verwendung |
individualOrderCode | Individueller Bestellcode Codebeispiel zur Verwendung Dieses Codebeispiel erzeugt folgende Ausgabe: LP-INDIVIDUAL-1242922021 |
invoiceAddress
| Rechnungsanschrift / Rechnungsadresse Die angegebene Rechnungsadresse der Bestellung, welche von einem Shop-Benutzer im Warenkorb angegeben worden ist. Diese Angabe kann über die Administration nachträglich verändert, oder von einem externen Prozess hinterlegt worden sei (bspw. SSO / OCI / REST-API / SAP / …). Codebeispiel zur Verwendung Das Objekt stellt weitere Variablen bereit, welche unter Template-Objekt „Adressdaten“ dokumentiert sind. |
invoiceDate | Rechnungsdatum Codebeispiel zur Verwendung |
invoiceNumber | Rechnungsnummer Codebeispiel zur Verwendung |
orderCode | Bestellcode Codebeispiel zur Verwendung |
orderDate | Bestelldatum Codebeispiel zur Verwendung |
orderInfo
| weitere Bestellinformationen Codebeispiel zur Verwendung Das Objekt innerhalb der Schleife stellt weitere Variablen bereit, welche unter Template-Objekt „Zusätzliche Bestellinformation“ dokumentiert sind. |
orderNumber | Bestellnummer Codebeispiel zur Verwendung |
payment
| Informationen zur Bezahlung Codebeispiel zur Verwendung Das Objekt stellt weitere Variablen bereit, welche unter Template-Objekt „Zahlungsart / Bezahlmethode“ dokumentiert sind. |
paymentMethod | Zahlungsart / Bezahlmethode Enthält die Bezeichnung der ausgewählten Zahlungsart der Bestellung. Codebeispiel zur Verwendung |
remark | Bemerkung zur Bestellung Codebeispiel zur Verwendung |
shipping
| Versandart Codebeispiel zur Verwendung Dieses Objekt stellt weitere Variablen bereit, welche unter Template-Objekt „Versanddaten (aus Bestelldaten)“ dokumentiert sind. |
shopUser
| Shop-Benutzer der Bestellung Codebeispiel zur Verwendung Dieses Objekt stellt weitere Variablen bereit, welche unter Template-Objekt „Shop-Benutzer“ dokumentiert sind. |
standardOrderCode | Standard-Bestellcode Codebeispiel zur Verwendung |
status | Bestellstatus Codebeispiel zur Verwendung |
total
| Bestellsumme Codebeispiel zur Verwendung |
totalWithoutVat
| Bestellsumme ohne Steuerbeträge Codebeispiel zur Verwendung |
totalWithVat
| Bestellsumme mit Steuerbeträgen Codebeispiel zur Verwendung |
vat | Steuerbetrag Codebeispiel zur Verwendung |
vatIdentificationNumber | Steuerliche Identifikationsnummer Codebeispiel zur Verwendung |