Template-Objekt „Bestellung“

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

Variable

Beschreibung und Verwendung

bankAccount object

Printlounge\DataObject\Template\TemplateBankAccount

Bankverbindungsdaten
enthält ein Objekt vom Typ Printlounge\DataObject\Template\TemplateBankAccount

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 https://beprint.atlassian.net/wiki/spaces/PL/pages/22492629 dokumentiert sind.

Tipp: Bei der Verwendung sollte mit einer {if}-Bedingung geprüft werden, ob diese Daten verfügbar sind.

barcode string

Barcode-Daten
enthält eine Zeichenkette / Text

Codebeispiel:

{$order->barcode}

budgetBefore integer

Budgetwert vor Bestellabschluss
enthält einen Zahlenwert (Ganzzahl)

Verfügbares Budget des Benutzers (oder der Benutzergruppe) vor Abschluss der Bestellung.

Codebeispiel zur Verwendung

{$order->budgetBefore}

budgetBooking integer

Verwendeter / Gebuchter Budgetwert für diese Bestellung
enthält einen Zahlenwert / Ganzzahl

Der Budgetwert, der für diese Bestellung berechnet und genutzt worden ist.

Codebeispiel zur Verwendung

budgetBookingAfter integer

Budgetwert nach Bestellabschluss
enthält einen Zahlenwert / Ganzzahl

Verfügbares Budget für den Benutzer (oder die Benutzergruppe) nach Abschluss der Bestellung.

Codebeispiel zur Verwendung

budgetBookingInCent integer

Verwendeter / Gebuchter Budgetwert in Cent
enthält einen Zahlenwert / Ganzzahl

Codebeispiel zur Verwendung

costCenter string

Kostenstelle aus der Lieferadresse
enthält eine Zeichenkette / Text

Ü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 array

Objektsammlung, enthält Objekte vom Typ Printlounge\DataObject\Template\TemplateCustomField

Freifelder im Warenkorb
enthält eine Sammlung von Objekten vom Typ Printlounge\DataObject\Template\TemplateCustomField

Wichtig: Diese Variable muss mit einer Schleife ({foreach}) durchlaufen werden, um die darin enthaltenen Informationen ausgeben zu können.

Codebeispiel zur Verwendung

Das Objekt innerhalb der Schleife stellt weitere Variablen bereit, welche unter https://beprint.atlassian.net/wiki/spaces/PL/pages/22492633 dokumentiert sind.

customFieldsByName array

Objektsammlung, enthält Objekte vom Typ Printlounge\DataObject\Template\TemplateCustomField

Freifelder im Warenkorb (strukturiert nach Name)
enthält eine Sammlung von Objekten vom Typ Printlounge\DataObject\Template\TemplateCustomField

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 https://beprint.atlassian.net/wiki/spaces/PL/pages/22492633 dokumentiert sind.

deliverDate DateTimeImmutable

Liefertermin
enthält eine Datums- / Zeitangabe vom Typ DateTimeImmutable

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 object

Printlounge\DataObject\Template\TemplateAddress

Lieferanschrift / Lieferadresse
enthält ein Objekt vom Typ Printlounge\DataObject\Template\TemplateAddress

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 dokumentiert sind.

description string

Beschreibung / Details
enthält eine Zeichenkette / Text

Codebeispiel zur Verwendung

externalOrderCode string

Externer Bestellcode
enthält eine Zeichenkette / Text

Codebeispiel zur Verwendung

Dieses Codebeispiel erzeugt folgende Ausgabe:

^{LP-EXTERNAL-1242922021}

freeFields array

Objektsammlung, enthält Objekte vom Typ Printlounge\DataObject\Template\TemplateFreeFields

Freifelder im Warenkorb
enthält eine Sammlung von Objekten vom Typ Printlounge\DataObject\Template\TemplateFreeFields

Objektsammlung aller Freifelder im Warenkorb der Bestellung.

Codebeispiel zur Verwendung

Das Objekt innerhalb der Schleife stellt weitere Variablen bereit, welche unter dokumentiert sind.

id integer

ID der Bestellung
enthält einen Zahlenwert / Ganzzahl

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 string

Individueller Bestellcode
enthält eine Zeichenkette / Text

Codebeispiel zur Verwendung

Dieses Codebeispiel erzeugt folgende Ausgabe:

^{LP-INDIVIDUAL-1242922021}

invoiceAddress object

Printlounge\DataObject\Template\TemplateAddress

Rechnungsanschrift / Rechnungsadresse
enthält ein Objekt vom Typ Printlounge\DataObject\Template\TemplateAddress

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 dokumentiert sind.

invoiceDate DateTimeImmutable

Rechnungsdatum
enthält eine Datums- / Zeitangabe vom Typ DateTimeImmutable

Codebeispiel zur Verwendung

invoiceNumber string

Rechnungsnummer
enthält eine Zeichenkette / Text

Codebeispiel zur Verwendung

orderCode string

Bestellcode
enthält eine Zeichenkette / Text

Codebeispiel zur Verwendung

orderDate DateTimeImmutable

Bestelldatum
enthält eine Datums- / Zeitangabe vom Typ DateTimeImmutable

Codebeispiel zur Verwendung

orderInfo array

Objektsammlung, enthält Objekte vom Typ Printlounge\DataObject\Template\TemplateOrderInfo

weitere Bestellinformationen
enthält eine Sammlung von Objekten vom Typ Printlounge\DataObject\Template\TemplateOrderInfo

Codebeispiel zur Verwendung

Das Objekt innerhalb der Schleife stellt weitere Variablen bereit, welche unter dokumentiert sind.

orderNumber integer

Bestellnummer
enthält einen Zahlenwert / Ganzzahl

Codebeispiel zur Verwendung

payment object

Printlounge\DataObject\Template\TemplatePayment

Informationen zur Bezahlung
enthält ein Objekt vom Typ Printlounge\DataObject\Template\TemplatePayment

Codebeispiel zur Verwendung

Das Objekt stellt weitere Variablen bereit, welche unter dokumentiert sind.

paymentMethod string

Zahlungsart / Bezahlmethode
enthält eine Zeichenkette / Text

Enthält die Bezeichnung der ausgewählten Zahlungsart der Bestellung.

Codebeispiel zur Verwendung

remark string

Bemerkung zur Bestellung
enthält eine Zeichenkette / Text

Codebeispiel zur Verwendung

shipping object

Printlounge\DataObject\Template\TemplateShipping

Versandart
enthält ein Objekt vom Typ Printlounge\DataObject\Template\TemplateShipping

Codebeispiel zur Verwendung

Dieses Objekt stellt weitere Variablen bereit, welche unter dokumentiert sind.

shopUser object

Printlounge\DataObject\Template\TemplateShopUser

Shop-Benutzer der Bestellung
enthält ein Objekt vom Typ Printlounge\DataObject\Template\TemplateShopUser

Codebeispiel zur Verwendung

Dieses Objekt stellt weitere Variablen bereit, welche unter dokumentiert sind.

standardOrderCode string

Standard-Bestellcode
enthält eine Zeichenkette / Text

Codebeispiel zur Verwendung

status integer

Bestellstatus
enthält einen Zahlenwert / Ganzzahl

Codebeispiel zur Verwendung

total object

Money\Money

Bestellsumme
enthält ein Objekt vom Typ Money\Money

Codebeispiel zur Verwendung

totalWithoutVat object

Money\Money

Bestellsumme ohne Steuerbeträge
enthält ein Objekt vom Typ Money\Money

Codebeispiel zur Verwendung

totalWithVat object

Money\Money

Bestellsumme mit Steuerbeträgen
enthält ein Objekt vom Typ Money\Money

Codebeispiel zur Verwendung

vat double

Steuerbetrag
enthält einen Zahlenwert / Fließkommazahl

Codebeispiel zur Verwendung

vatIdentificationNumber string

Steuerliche Identifikationsnummer
enthält eine Zeichenkette / Text

Codebeispiel zur Verwendung