class ProductLineItem extends AbstractElement

Artikeldaten in einer Bestellung

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.

 <product-line-item>
   <position>1</position>
   <partner-product-no>1565107</partner-product-no>
   <Size>XL</Size>
   <EAN>1234567891234</EAN>
   <product-name>Handtuch</product-name>
   <product-short-description>Handtuch</product-short-description>
   <quantity>1</quantity>
   <unit>Stk</unit>
   <single-base-price>5.99</single-base-price>
   <single-price>5.99</single-price>
   <gross-price>5.99</gross-price>

  </product-line-item>

Traits

XpathImplementation

Properties

static protected $stateList
protected string $referencenumber

Methods

NodeList
searchElements(string $elementName)

searchElements

Parser
getParser()

Liefert einen neues Parser Objekt und setzt den Namespace "\Alvine\Merchant\Otto\Element\"

string
getElementValue(string $elementName)

Hilfsmethode Gibt den Wert eines Elementes zurück

setElementValue($elementName, $value)

Hilfsmethode Setzt den Wert eines Elementes Wenn dieses Element noch nicht angelegt wurde wird es angelegt

__construct(string $tag = null, string $value = '', null|AttributeMap $attributes = null)

Erstellt ein neues ProductLineItem-Objekt

integer
getPartnerProductNo()

Artikelnummer des Partners

integer
getPosition()

Positionsnummer

ProductLineItem
setPosition(integer $position)

Setzt die Positionsnummer

decimal
getQuantity()

Menge

setQuantity(string $quantity)

Setzt die Menge

string
getSize()

Artikelgröße

string
getEAN()

EAN

string
getProductName()

Produktname

string
getProductShortDescription()

Produktkurzbeschreibung

string
getUnit()

Mengeneinheit

string
getSingleBasePrice()

Bruttolistenpreis der entsprechenden Bestellposition

string
getSinglePrice()

Bruttopreis, nach Rabattabzug

string
getGrossPrice()

gesamten Bruttopreis der Bestellposition

ProductLineItem
setModificationDate(DateTime $dateTime)

Setzt den Zeitstempel bei der Erstellung des Bestellstatus

DateTime
getModificationDate()

Liefert den Zeitstempel der letzten änderung zurück

integer
getOrderStatus()

Liefert den Status der Position zurück

setOrderStatus($state)

Setzt den Status der Position

getShipToAddress()

Liefert die Lieferadresse dieser Position zurück

string
getReferencenumber()

Liefert die Referenznummer zurück

setReferencenumber(string $referencenumber)

Setzt die Referenznummer

Details

in XpathImplementation at line 42
NodeList searchElements(string $elementName)

searchElements

Parameters

string $elementName Name des Elements

Return Value

NodeList Liste der gefundenen Elemente

in AbstractElement at line 44
protected Parser getParser()

Liefert einen neues Parser Objekt und setzt den Namespace "\Alvine\Merchant\Otto\Element\"

Return Value

Parser Parser

in AbstractElement at line 55
protected string getElementValue(string $elementName)

Hilfsmethode Gibt den Wert eines Elementes zurück

Parameters

string $elementName Name des Elementes

Return Value

string Wert des Elementes

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

Parameters

$elementName
$value

Return Value

AbstractElement dieses Objekt

at line 62
__construct(string $tag = null, string $value = '', null|AttributeMap $attributes = null)

Erstellt ein neues ProductLineItem-Objekt

Parameters

string $tag Tag
string $value Wert
null|AttributeMap $attributes Atributes

at line 108
integer getPartnerProductNo()

Artikelnummer des Partners

Datentyp: String Restriktionen: Minimale Länge: 1 / Maximale Länge: 20 Minimalanforderungen: Pflichtfeld Maximalanforderungen: -

 <partner-product-no>1234567890</partner-product-no>

Durch die partner-product-no wird dem Partner mitgeteilt, welches seiner Produkte bestellt worden ist. Sie stellt (wenn nötig mit der Produktgröße) den eindeutigen Schlüssel für den Partnerartikel dar.

Return Value

integer Artikelnummer des Partners

at line 129
integer getPosition()

Positionsnummer

Datentyp: integer Restriktionen: nicht negativ Minimalanforderungen: Pflichtfeld Maximalanforderungen: -

 <position>1</position>

Mit Hilfe des Feldes position kann jede Bestellposition innerhalb einer Bestellung eindeutig identifiziert werden. Sie wird in einer Bestellung fortlaufend vergeben.

Return Value

integer Positionsnummer

at line 140
ProductLineItem setPosition(integer $position)

Setzt die Positionsnummer

Parameters

integer $position Positionsnummer

Return Value

ProductLineItem dieses Objekt

at line 161
decimal getQuantity()

Menge

Datentyp: decimal Restriktionen: - Minimalanforderungen: Pflichtfeld Maximalanforderungen: -

 <quantity>1</quantity>

Mit dem Feld quantity wird die bestellte Menge dieser Bestellposition beziffert.

Return Value

decimal Menge

at line 172
ProductLineItem setQuantity(string $quantity)

Setzt die Menge

Parameters

string $quantity Menge

Return Value

ProductLineItem dieses Objekt

at line 196
string getSize()

Artikelgröße

Datentyp: String Restriktionen: Minimale Länge: 1 / Maximale Länge: 15 Minimalanforderungen: Pflichtfeld Maximalanforderungen: -

 <Size>34</Size>

Wenn ein Partnerartikel nicht eindeutig mit Hilfe der Artikelnummer identifiziert werden kann, muss die Eindeutigkeit über die Angabe der Artikelgröße hergestellt werden. Wenn der bestellte Artikel keine Größenbezeichnung hat (also ein Leerzeichen oder „none“ in den Stammdaten angegeben wurde), wird ein leeres Tag geschickt. Der übermittelte Wert „none“ wird nicht zurückgegeben.

Return Value

string Artikelgröße

at line 207
string getEAN()

EAN

Liefert die EAN der Position zurück

Return Value

string EAN

at line 228
string getProductName()

Produktname

Datentyp: String Restriktionen: Minimale Länge: 1 / Maximale Länge: 4000 Minimalanforderungen: Pflichtfeld Maximalanforderungen: -

 <product-name>T-Shirt &quot;neckles&quot;</product-name>

Das Feld product-name bezeichnet den Artikelnamen der bestellten Ware. Achtung: Der Produktname wird HTML-codiert übermittelt.

Return Value

string Produktname

at line 248
string getProductShortDescription()

Produktkurzbeschreibung

Datentyp: String Restriktionen: Minimale Länge: 1 / Maximale Länge: 4000 Minimalanforderungen: Pflichtfeld Maximalanforderungen: -

 <product-short-description>Poloshirt, H.I.S.</product-short-description>

Dieses Feld beinhaltet die Kurzbeschreibung des bestellten Artikels.

Return Value

string Produktkurzbeschreibung

at line 271
string getUnit()

Mengeneinheit

Datentyp: String Restriktionen: Minimale Länge: 1 / Maximale Länge: 256 Pflichtfeld / optional: Optional Minimalanforderungen: Keine Maximalanforderungen: -

 <unit>PCE</unit>

In dem Feld unit wird die Mengeneinheit dieser Bestellposition spezifiziert. Hier wird der Wert zurückgegeben, den der Partner bei der Artikelerrichtung angegeben hat. Momentan sind die Werte PCE (=Stück), MTR (=Meter) sowie MTK (=Quadratmeter) möglich.

Return Value

string Produktkurzbeschreibung

at line 293
string getSingleBasePrice()

Bruttolistenpreis der entsprechenden Bestellposition

Datentyp: decimal Restriktionen: 2 Nachkommastellen Pflichtfeld / optional: Pflichtfeld Minimalanforderungen: Pflichtfeld Maximalanforderungen: -

 <single-base-price>9.9</single-base-price>

Der single-base-price gibt den Bruttolistenpreis der entsprechenden Bestellposition pro Einheit an, ohne dabei Rabatte zu berücksichtigen.

Return Value

string Produktkurzbeschreibung

at line 314
string getSinglePrice()

Bruttopreis, nach Rabattabzug

Datentyp: decimal Restriktionen: 2 Nachkommastellen Pflichtfeld / optional: Pflichtfeld Minimalanforderungen: Pflichtfeld Maximalanforderungen: -

 <single-price>9.9</single-price>

Der single-price gibt den Bruttopreis, nach Rabattabzug an.

Return Value

string Bruttopreis, nach Rabattabzug

at line 335
string getGrossPrice()

gesamten Bruttopreis der Bestellposition

Datentyp: decimal Restriktionen: 2 Nachkommastellen Pflichtfeld / optional: Pflichtfeld Minimalanforderungen: Pflichtfeld Maximalanforderungen: -

 <gross-price>9.9</gross-price>

Der gross-price beinhaltet den gesamten Bruttopreis der Bestellposition (d.h. single price x Menge).

Return Value

string gesamten Bruttopreis der Bestellposition

at line 360
ProductLineItem setModificationDate(DateTime $dateTime)

Setzt den Zeitstempel bei der Erstellung des Bestellstatus

Datentyp: decimal Restriktionen: 2 Nachkommastellen Pflichtfeld / optional: Pflichtfeld Minimalanforderungen: Pflichtfeld Maximalanforderungen: -

 <ModificationDate>2005-07-25T18:45:13 </ModificationDate>

Der Zeitstempel gibt mit Hilfe einer sekundengenauen Uhrzeit an, wann sich der jeweilige Bestellstatus geändert hat. Sollten bei OTTO mehrere Statusmeldungen zu einer Position vorliegen, so wird der aktuellste Status anhand des Zeitstempels gesetzt

Parameters

DateTime $dateTime

Return Value

ProductLineItem dieses Objekt

at line 370
DateTime getModificationDate()

Liefert den Zeitstempel der letzten änderung zurück

Return Value

DateTime Zeitstempel

at line 384
integer getOrderStatus()

Liefert den Status der Position zurück

Return Value

integer Status

at line 395
ProductLineItem setOrderStatus($state)

Setzt den Status der Position

Parameters

$state

Return Value

ProductLineItem dieses Objekt

Exceptions

UnsupportedStateException

at line 413
ShipToAddress getShipToAddress()

Liefert die Lieferadresse dieser Position 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.

Return Value

ShipToAddress | false Lieferadresse der Position

at line 423
string getReferencenumber()

Liefert die Referenznummer zurück

Return Value

string | \null Referenznummer

at line 434
ProductLineItem setReferencenumber(string $referencenumber)

Setzt die Referenznummer

Parameters

string $referencenumber Referenznummer

Return Value

ProductLineItem dieses Objekt