Order
class Order extends AbstractElement
Order
Abbildung einer Order
Traits
Methods
Liefert einen neues Parser Objekt und setzt den Namespace "\Alvine\Merchant\Otto\Element\"
Hilfsmethode Gibt den Wert eines Elementes zurück
Hilfsmethode Setzt den Wert eines Elementes Wenn dieses Element noch nicht angelegt wurde wird es angelegt
Erstellt ein neues Order-Objekt
Liefert die Transaktionsnummer zurück
Liefert das Erstellungsdatum zurück
Liefert des Währungscode zurück
Liefert die Kundennummer (verschlüsselt) zurück
Liefert die Gesamtbestellwert, brutto zurück
Liefert die Liefermethode zurück
Liefert die Zahlungsart zurück
Liefert die TransactionID der Kreditkarte zurück
Liefert die Rechnungsadresse zurück
Liefert die Lieferadresse zurück
Liefert die Artikeldaten zurück
Liefert die Servicedaten zurück
Liefert den Verwendungszweck zurück
Details
in XpathImplementation at line 42
NodeList
searchElements(string $elementName)
searchElements
in AbstractElement at line 44
protected Parser
getParser()
Liefert einen neues Parser Objekt und setzt den Namespace "\Alvine\Merchant\Otto\Element\"
in AbstractElement at line 55
protected string
getElementValue(string $elementName)
Hilfsmethode Gibt den Wert eines Elementes zurück
in AbstractElement at line 72
protected AbstractElement
setElementValue($elementName, $value)
Hilfsmethode Setzt den Wert eines Elementes Wenn dieses Element noch nicht angelegt wurde wird es angelegt
at line 42
__construct(string $tag = null, string $value = '', null|AttributeMap $attributes = null)
Erstellt ein neues Order-Objekt
at line 72
string
getOrderNo()
Liefert die Transaktionsnummer zurück
Datentyp: String Restriktionen: Minimale Länge: 1 / Maximale Länge: 20 Minimalanforderungen: Pflichtfeld
<order-no>11254766</order-no>
Die order-no beinhaltet die eindeutige Transaktionsnummer (Auftragsnummer), die OTTO für diese Partnerbestellung angelegt hat. Ändert sich im Laufe des Bestelllebenszykluses der Status der Bestellung (bspw. von offen ausgeliefert) so muss diese Statusänderung, mit Hilfe der Transaktionsnummer an OTTO gemeldet werden. Bitte beachten Sie, dass die Transaktionsnr. für alle Positionen aus einer Kundenbestellung gleich ist. Dies gilt auch wenn mehrere Kooperationspartner in dem Auftrag enthalten sind.
at line 92
DateTime
getCreationDate()
Liefert das Erstellungsdatum zurück
Datentyp: DateTime Minimalanforderungen: Pflichtfeld Maximalanforderungen: -
<creation-date>2005-07-18T14:38:55</creation-date>
Das Erstellungsdatum gibt mit Hilfe eines sekundengenauen Zeitstempels an, wann die jeweilige Bestellung bei OTTO erzeugt wurde.
at line 113
string
getPurchaseCurrency()
Liefert des Währungscode zurück
Datentyp: String Restriktionen: Länge: 3 Zeichen / nur Buchstaben möglich! Minimalanforderungen: Pflichtfeld Maximalanforderungen: -
<purchase-currency>EUR</purchase-currency>
In diesem Feld wird die Währung erfasst, die für diese Bestellung gilt. Die Währung wird mit Hilfe des 3-stelligen ISO-Codes (siehe ISO 4217) festgelegt.
at line 136
string
getBuyerNo()
Liefert die Kundennummer (verschlüsselt) zurück
Datentyp: String Restriktionen: Minimale Länge: 1 / Maximale Länge: 256 Minimalanforderungen: Pflichtfeld Maximalanforderungen: -
<buyer-no>NTcyMTgxNQ==</buyer-no>
Mit Hilfe der buyer-no wird dem Partner die, aus Gründen des Datenschutzes, verschlüsselte OTTO-Kundennummer übergeben. Die buyer-no ist für jede Bestellung des Kunden identisch. Zukünftige Bestellungen des gleichen Kunden können somit identifiziert werden.
at line 156
float
getGrandTotalGrossPrice()
Liefert die Gesamtbestellwert, brutto zurück
Datentyp: decimal Restriktionen: 2 Nachkommastellen Minimalanforderungen: Pflichtfeld Maximalanforderungen: -
<grand-total-gross-price>15.85</grand-total-grossprice>
Mit Hilfe des grand-total-gross-price wird der Gesamtbetrag der Rechnung (brutto) ausgewiesen.
at line 178
string
getShippingMethod()
Liefert die Liefermethode zurück
Datentyp: String Restriktionen: Nur Werte aus einem vordefinierten Wertebereich wählbar! Minimalanforderungen: Pflichtfeld Maximalanforderungen: -
<shipping-method>DEFAULT</shipping-method>
Die shipping-method beschreibt die Liefermethode, die der Kunde für diese Bestellung ausgewählt hat. Hier kann momentan nur der Wert DEFAULT übergeben werden.
at line 195
string
getPaymentMethod()
Liefert die Zahlungsart zurück
<payment-method>CASH_ON_DELIVERY</payment-method>
Dementsprechend beschreibt die payment-method die Zahlungsart, für die sich der Kunde entschieden hat. Mögliche Werte sind PURCHASE_ON_ACCOUNT (= Rechnungskauf) und PREPAYMENT (=Vorkasse)
at line 208
string
getCreditCardTransactionID()
Liefert die TransactionID der Kreditkarte zurück
<CreditCardTransactionID>001C388F</CreditCardTransactionID>
at line 223
InvoiceToAddress
getInvoiceToAddress()
Liefert die Rechnungsadresse zurück
Die Rechnungsadresse wird einmal pro Bestellung übergeben. Das XML-Element trägt den Namen invoice-to-address. Dieses XML-Tag beinhaltet alle typischen Bestandteile einer Rechnungsadresse. Im Einzelnen handelt es sich dabei um die folgenden Inhalte. Straße, Postleitzahl, Ort & Land Anrede, Vorwahl, Telefonnummer & E-Mail-Adresse Vorname & Nachname Als XML-File sollte die Rechnungsadresse etwa folgendes Aussehen besitzen.
at line 240
ShipToAddress
getShipToAddress()
Liefert die Lieferadresse zurück
Soll die komplette Bestellung oder eine einzelne Bestellposition an eine von der Rechnungsadresse abweichende Anschrift geliefert werden, so wird diese Anschrift in dem XML-Element ship-to-address übergeben. Das Element kann sowohl auf Bestellungs- sowie auf Bestellpositionsebene übergeben werden. Je nachdem, ob die ganze Bestellung oder nur eine Bestellposition an die Lieferadresse gesendet werden soll. Die Lieferadresse hat den folgenden Aufbau: Straße, Postleitzahl, Ort & Land Anrede, Vorwahl, Telefonnummer und Vorname Nachname Lieferhinweis des Kunden
at line 254
Order
setShipToAddress(ShipToAddress $shipToAddress)
Setzt die Lieferadresse
Wenn bereits eine vorhanden ist wird diese mit der neuen Ersetzt
at line 272
ProductLineItems
getProductLineItems()
Liefert die Artikeldaten zurück
Mit Hilfe der Artikeldaten werden die einzelnen Positionen der Bestellung an den Partner übermittelt. Das übergeordnete Element trägt den Namen product-lineitems. In diesem Container können 1-n product-line-item Elemente enthalten sein, wobei jedes Unterelement eine Bestellposition repräsentiert.
at line 286
Order
setProductLineItems(ProductLineItems $productLineItems)
Setzt die Bestellpositionen
Wenn bereits Bestellpositionen vorhanden sind werden diese mit den neuen ersetzt
at line 304
Order
appendProductLineItem(ProductLineItem $productLineItem)
Fügt eine Bestellpostion ein
Wenn der TAG ProductLineItems nicht vorhanden ist wird dieser angelegt
at line 338
ServiceLineItems
getServiceLineItems()
Liefert die Servicedaten zurück
Bei jeder Bestellung werden vom Kunden unterschiedliche Transport- bzw. Zahlungsarten in Anspruch genommen. Über die Servicedaten wird der Partner darüber informiert. Momentan (Stand 12.12.05) werden folgende Informationen geliefert:
- Lieferung per Eilservice
- Zahlung per Nachnahme
- Transportkosten
- Speditionsaufschlag
- Summe der Servicekosten
Das übergeordnete Element, das die Servicedaten beinhaltet , trägt den Namen service-line-items. Es kann als Container 0 - n service-line-item Elemente beinhalten, wobei jedes Unterelement eine Serviceposition repräsentiert.
Jede Serviceposition besteht aus den folgenden Bestandteilen. - Servicename - Servicepreis (brutto) sowie Gesamtpreis (brutto)
at line 359
string
getDescriptor()
Liefert den Verwendungszweck zurück
Der Verwendungszweck wird von RatePAY erweitert
Datentyp: String Restriktionen: Länge: 255 Zeichen Minimalanforderungen: Pflichtfeld Maximalanforderungen: -
<descriptor>DG123456789</descriptor>