Orderlines Lesen

pixiReadOrderlines

Liefert Auftragspositionen aus `Orderlines` nach Schlüssel, Schlüsselbereich oder Anlage-/Änderungszeitraum, inklusive Währung, Wechselkurs, Versandkosten und voraussichtlicher Lieferung.

Liest Auftragspositionen in einem von mehreren Auswahlmodi. Ein fehlender OrderlineKey wird als 0 behandelt. Es gilt der erste zutreffende Modus:

Angelegt oder geändert – wenn CreateAndUpdateDateFrom oder CreateAndUpdateDateTo gesetzt ist: Positionen mit OrderlineKey > OrderlineKey, deren CreateDate oder UpdateDate im Zeitraum liegt.
Angelegt – sonst, wenn CreateDateFrom oder CreateDateTo gesetzt ist: Positionen mit Schlüssel > OrderlineKey, deren CreateDate im Zeitraum liegt.
Geändert – sonst, wenn UpdateDateFrom oder UpdateDateTo gesetzt ist: Positionen mit Schlüssel > OrderlineKey, deren UpdateDate im Zeitraum liegt.
Schlüsselbereich – sonst, wenn RowCount übergeben wird (jeder Wert, auch 0): alle Positionen mit Schlüssel > OrderlineKey.
Einzelne Position – andernfalls: die Position mit genau diesem OrderlineKey.

In den Datumsmodi wird eine fehlende Untergrenze auf 10 Jahre vor der aktuellen Serverzeit gesetzt, eine fehlende Obergrenze auf die aktuelle Serverzeit (GETDATE()). Die Grenzen sind inklusiv (BETWEEN).

Ist RowCount > 0, wird die Zeilenzahl auf RowCount begrenzt, beginnend mit den kleinsten Schlüsseln. Das Ergebnis ist aufsteigend nach OrderlineKey sortiert. Damit ist Keyset-Paging möglich: den zuletzt gelieferten OrderlineKey im nächsten Aufruf als OrderlineKey übergeben.

Jede Position wird mit ihrem Auftragskopf (OrderHeader), dem Wechselkurs und der Währung des Auftrags sowie optional mit Orderline_EstimatedDelivery verknüpft.

Hinweise

Alle Tabellen werden WITH (NOLOCK) gelesen; nicht festgeschriebene oder inkonsistente Daten sind möglich.
Die Begrenzung erfolgt per SET ROWCOUNT und wirkt sowohl auf die Kandidatenauswahl als auch auf die Abschlussabfrage.
Positionen werden nur geliefert, wenn Auftragskopf, Wechselkurs (pixi.ExchRate) und Währung (pixi.Currency) existieren (Inner Joins). Eine Seite kann daher weniger als RowCount Zeilen enthalten, obwohl weitere Daten folgen; ab dem letzten Schlüssel weiterblättern und erst bei leerem Ergebnis aufhören.
Enthält Orderline_EstimatedDelivery mehrere Zeilen pro Position, erscheint die Position mehrfach.
RowCount = 0 ohne Datumsfilter liefert alle Positionen oberhalb von OrderlineKey ohne Begrenzung.
Ein Aufruf ohne Parameter sucht OrderlineKey = 0 und liefert in der Regel keine Zeilen.
Die Datumsfilter haben in der genannten Reihenfolge Vorrang; pro Aufruf wird nur ein Datumsmodus verwendet.
Price_OrderCurr entspricht Price, ShipCost_OrderCurr entspricht ShipCost, Price_OrderCurr_Set und ShipCost_OrderCurr_Set sind immer 0, SOrderlineRef ist immer NULL. Kommentare im Code markieren die _OrderCurr-Spalten zur Entfernung.
ShipCost sind die Versandkosten des gesamten Auftragskopfs und werden in jeder Position des Auftrags wiederholt.

Parameter

Parameter	Typ	Standardwert	Beschreibung
`OrderlineKey`	int	NULL	Im Einzelmodus der Schlüssel der gewünschten Position; in allen anderen Modi werden nur Positionen mit größerem Schlüssel geliefert (Paging-Start). `NULL` wird als `0` behandelt. Beispiel: `0`
`CreateDateFrom`	datetime dateTime	NULL	Untergrenze für `CreateDate` (inklusiv). Standard 10 Jahre zurück, wenn nur die Obergrenze gesetzt ist. Beispiel: `2024-01-01T00:00:00`
`CreateDateTo`	datetime dateTime	NULL	Obergrenze für `CreateDate` (inklusiv). Standard ist die aktuelle Serverzeit, wenn nur die Untergrenze gesetzt ist. Beispiel: `2024-01-31T23:59:59`
`UpdateDateFrom`	datetime dateTime	NULL	Untergrenze für `UpdateDate` (inklusiv). Wird nur verwendet, wenn kein Anlage- bzw. Anlage-und-Änderungs-Filter gesetzt ist. Beispiel: `2024-05-01T00:00:00`
`UpdateDateTo`	datetime dateTime	NULL	Obergrenze für `UpdateDate` (inklusiv). Standard ist die aktuelle Serverzeit. Beispiel: `2024-05-02T00:00:00`
`CreateAndUpdateDateFrom`	datetime dateTime	NULL	Untergrenze; geliefert werden Positionen, deren `CreateDate` oder `UpdateDate` im Zeitraum liegt. Hat Vorrang vor allen anderen Datumsfiltern. Beispiel: `2024-05-01T00:00:00`
`CreateAndUpdateDateTo`	datetime dateTime	NULL	Obergrenze für den kombinierten Anlage-/Änderungsfilter. Standard ist die aktuelle Serverzeit. Beispiel: `2024-05-02T00:00:00`
`RowCount`	int	NULL	Maximale Zeilenzahl, wenn > 0. Wird der Parameter ohne Datumsfilter übergeben, gilt der Schlüsselbereichsmodus (alle Positionen mit Schlüssel > `OrderlineKey`). Beispiel: `500`

Antwort

Result-Set 1 · Immer; kann leer sein.

Ausgewählte Auftragspositionen mit Auftragswährung, Wechselkurs, Versandkosten des Auftrags und voraussichtlicher Lieferung, aufsteigend nach OrderlineKey sortiert.

Spalte	Typ	Beschreibung
`OrderlineKey`	int	Schlüssel der Auftragsposition.
`OrderNr`	int	Auftragsnummer (Verknüpfung zu `OrderHeader`).
`CustRef` Kann leer sein	int	Kundenreferenz.
`AddrRef` Kann leer sein	int	Adressreferenz.
`ShipAdrRef` Kann leer sein	int	Referenz der Lieferadresse.
`InvRef` Kann leer sein	int	Rechnungsreferenz.
`NODRef` Kann leer sein	int	Wert von `Orderlines.NODRef`.
`SupplRef` Kann leer sein	string	Lieferantenreferenz.
`SupplInfo` Kann leer sein	string	Lieferanteninformation.
`ShipRef` Kann leer sein	int	Versandreferenz.
`ArtNr` Kann leer sein	string	Artikelnummer.
`ArtName` Kann leer sein	string	Artikelbezeichnung.
`Qty` Kann leer sein	int	Menge.
`Backlist` Kann leer sein	string	Wert von `Orderlines.Backlist`.
`Price` Kann leer sein	decimal	Verkaufspreis der Position.
`SupplPrice` Kann leer sein	decimal	Lieferanten-(Einkaufs-)preis.
`ArtVAT` Kann leer sein	string	MwSt.-Kennzeichen des Artikels.
`Status` Kann leer sein	string	Status der Auftragsposition.
`Note` Kann leer sein	string	Notiz.
`OrderMS` Kann leer sein	string	Wert von `Orderlines.OrderMS`.
`ConfMS` Kann leer sein	string	Wert von `Orderlines.ConfMS`.
`ConfigType` Kann leer sein	string	Wert von `Orderlines.ConfigType`.
`MusicType` Kann leer sein	string	Wert von `Orderlines.MusicType`.
`Source` Kann leer sein	string	Herkunft der Auftragsposition.
`OrderDate` Kann leer sein	dateTime	Bestelldatum.
`TimeZone` Kann leer sein	string	Zeitzone.
`SOrderDate` Kann leer sein	dateTime	Datum der Lieferantenbestellung.
`ConfDate` Kann leer sein	dateTime	Bestätigungsdatum.
`ConfVia` Kann leer sein	string	Bestätigungsweg.
`LConfDate` Kann leer sein	dateTime	Datum der letzten Bestätigung.
`LConfVia` Kann leer sein	string	Weg der letzten Bestätigung.
`ShipDate` Kann leer sein	dateTime	Versanddatum.
`AktionsKennz` Kann leer sein	string	Aktionskennzeichen.
`Discount` Kann leer sein	decimal	Rabatt.
`ShipId` Kann leer sein	string	Versand-ID.
`BoxNr` Kann leer sein	string	Kistennummer.
`OrderLineType` Kann leer sein	string	Typ der Auftragsposition.
`BackorderRef` Kann leer sein	int	Rückstandsreferenz.
`OrderCurrency` Kann leer sein	string	Währungscode des Auftrags (`pixi.Currency.CodeA`).
`CreateDate` Kann leer sein	dateTime	Anlagedatum.
`CreateEmp` Kann leer sein	string	Mitarbeiter, der die Position angelegt hat.
`UpdateDate` Kann leer sein	dateTime	Datum der letzten Änderung.
`UpdateEmp` Kann leer sein	string	Mitarbeiter der letzten Änderung.
`OrderExchRate` Kann leer sein	decimal	Wechselkurs des Auftrags (`pixi.ExchRate.ExchRate`).
`ItemRef` Kann leer sein	int	Artikelreferenz.
`WaitDays` Kann leer sein	int	Wartetage.
`Price_OrderCurr` Kann leer sein	decimal	Gleicher Wert wie `Price`; zur Entfernung vorgesehen.
`TaxAmount` Kann leer sein	decimal	Steuerbetrag.
`TaxRate` Kann leer sein	decimal	Steuersatz.
`ShipCost` Kann leer sein	decimal	Versandkosten des Auftragskopfs (`OrderHeader.ShipCost`).
`ShipCostPerItem` Kann leer sein	decimal	Versandkosten pro Artikel.
`ShipCost_OrderCurr` Kann leer sein	decimal	Gleicher Wert wie `ShipCost`; zur Entfernung vorgesehen.
`OrderNrExternal` Kann leer sein	string	Externe Auftragsnummer (z. B. Shop-Bestellnummer).
`ItemNrExternal` Kann leer sein	string	Externe Artikelnummer.
`LocationID` Kann leer sein	string	Lager-ID.
`LastOrdLocationID` Kann leer sein	string	Lager der letzten Bestellung.
`SupplGroup` Kann leer sein	string	Lieferantengruppe.
`SOrderlineRef` Kann leer sein	int	Immer `NULL`.
`CustomerEMailed` Kann leer sein	string	Wert von `Orderlines.CustomerEMailed` (Kundenbenachrichtigung).
`DelayEMailed` Kann leer sein	string	Wert von `Orderlines.DelayEMailed` (Verzögerungsbenachrichtigung).
`SupplGroupScanIn` Kann leer sein	string	Wert von `Orderlines.SupplGroupScanIn`.
`rowguid` Kann leer sein	string	Zeilen-GUID.
`OrdShopID` Kann leer sein	string	Shop-ID des Auftrags.
`OrGosF1` Kann leer sein	string	Wert von `Orderlines.OrGosF1`.
`OrGosF2` Kann leer sein	string	Wert von `Orderlines.OrGosF2`.
`SupplPrice_Source` Kann leer sein	decimal	Lieferantenpreis in Ursprungswährung.
`Curr_Source` Kann leer sein	string	Ursprungswährung.
`LastDelayEmail` Kann leer sein	dateTime	Letzte Verzögerungs-E-Mail.
`ConfEmailed` Kann leer sein	string	Wert von `Orderlines.ConfEmailed` (Bestätigungs-E-Mail).
`HALEmailed` Kann leer sein	string	Wert von `Orderlines.HALEmailed`.
`CCReqEmailed` Kann leer sein	string	Wert von `Orderlines.CCReqEmailed`.
`CCEXpEmailed` Kann leer sein	string	Wert von `Orderlines.CCEXpEmailed`.
`NotEmailed` Kann leer sein	string	Wert von `Orderlines.NotEmailed`.
`OrShippingNote` Kann leer sein	string	Versandhinweis.
`ForceFirstSuppl` Kann leer sein	string	Wert von `Orderlines.ForceFirstSuppl`.
`ForceLocToSuppl` Kann leer sein	string	Wert von `Orderlines.ForceLocToSuppl`.
`ForceParallelShip` Kann leer sein	string	Wert von `Orderlines.ForceParallelShip`.
`VoucherID` Kann leer sein	string	Gutschein-ID.
`OrReplFlag` Kann leer sein	string	Wert von `Orderlines.OrReplFlag`.
`OrCCPLock` Kann leer sein	string	Wert von `Orderlines.OrCCPLock`.
`ChangeDate` Kann leer sein	dateTime	Änderungsdatum.
`ChangeSequence` Kann leer sein	long	Änderungssequenz.
`InvSorderlineRef` Kann leer sein	int	Wert von `Orderlines.InvSorderlineRef`.
`BundleOrderlineRef` Kann leer sein	int	Referenz auf die Set-Auftragsposition.
`Refunded` Kann leer sein	string	Wert von `Orderlines.Refunded`.
`DIcheckbox` Kann leer sein	string	Wert von `Orderlines.DIcheckbox`.
`OriginalOrderlineRef` Kann leer sein	int	Referenz auf die ursprüngliche Auftragsposition.
`oItemSpecialNote` Kann leer sein	string	Spezialhinweis zum Artikel.
`DiscountValue` Kann leer sein	decimal	Rabattbetrag.
`DiscountPerc` Kann leer sein	decimal	Rabatt in Prozent.
`BookAccountNr` Kann leer sein	string	Buchungskontonummer.
`SerialNr` Kann leer sein	string	Seriennummer.
`UpdateBackToHal` Kann leer sein	string	Wert von `Orderlines.UpdateBackToHal`.
`AlreadyOrdered` Kann leer sein	string	Wert von `Orderlines.AlreadyOrdered`.
`FullPrice` Kann leer sein	decimal	Vollpreis.
`DF_type` Kann leer sein	string	Direct-Fulfillment-Typ.
`DFShipDate` Kann leer sein	dateTime	Direct-Fulfillment-Versanddatum.
`DFShipmentTrackingID` Kann leer sein	string	Direct-Fulfillment-Sendungsverfolgungs-ID.
`NLBCustomerEmailed` Kann leer sein	string	Wert von `Orderlines.NLBCustomerEmailed`.
`PriceWeightUnits_Price` Kann leer sein	decimal	Wert von `Orderlines.PriceWeightUnits_Price`.
`MeasuredWeight` Kann leer sein	decimal	Gemessenes Gewicht.
`OrderDateStartOfDay` Kann leer sein	dateTime	Bestelldatum auf Tagesbeginn gekürzt.
`PickListNrUsed` Kann leer sein	string	Verwendete Picklistennummer.
`InvoiceNrExternal` Kann leer sein	string	Externe Rechnungsnummer.
`Order_Id` Kann leer sein	int	Wert von `Orderlines.Order_Id`.
`ItemOriginalFullPrice` Kann leer sein	decimal	Ursprünglicher Vollpreis des Artikels.
`Price_Net` Kann leer sein	decimal	Nettopreis.
`Price_OrderCurr_Set`	int	Immer `0`; zur Entfernung vorgesehen.
`ShipCost_OrderCurr_Set`	int	Immer `0`; zur Entfernung vorgesehen.
`VATPercent` Kann leer sein	decimal	MwSt.-Satz in Prozent.
`VATsRef` Kann leer sein	int	MwSt.-Referenz.
`BatchNumber` Kann leer sein	string	Chargennummer.
`BestBeforeDate` Kann leer sein	dateTime	Mindesthaltbarkeitsdatum.
`RealSorderlineRef` Kann leer sein	int	Aus `Orderline_EstimatedDelivery`; `NULL`, wenn kein Eintrag existiert.
`EstimatedDelivery` Kann leer sein	datetime dateTime	Voraussichtliches Lieferdatum aus `Orderline_EstimatedDelivery`; `NULL`, wenn kein Eintrag existiert.

Beispielantwort

<SqlRowSet1>
  <row>
    <OrderlineKey>184523</OrderlineKey>
    <OrderNr>90211</OrderNr>
    <CustRef>4711</CustRef>
    <ArtNr>AB-1001</ArtNr>
    <ArtName>T-Shirt blau M</ArtName>
    <Qty>2</Qty>
    <Price>19.9900</Price>
    <Status>AU</Status>
    <OrderDate>2024-05-01T10:15:00</OrderDate>
    <OrderCurrency>EUR</OrderCurrency>
    <OrderExchRate>1.0000</OrderExchRate>
    <ShipCost>4.9000</ShipCost>
    <OrderNrExternal>SHOP-100234</OrderNrExternal>
    <LocationID>001</LocationID>
    <CreateDate>2024-05-01T10:15:03</CreateDate>
    <UpdateDate>2024-05-01T11:02:40</UpdateDate>
    <Price_OrderCurr_Set>0</Price_OrderCurr_Set>
    <ShipCost_OrderCurr_Set>0</ShipCost_OrderCurr_Set>
    <EstimatedDelivery>2024-05-03T00:00:00</EstimatedDelivery>
  </row>
</SqlRowSet1>

Beispiele

POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
Authorization: Basic BASE64(USERNAME:PASSWORD)

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://apigateway.descartes.com/tms/pixi/">
  <SOAP-ENV:Body>
    <ns1:pixiReadOrderlines>
      <!-- <OrderlineKey>0</OrderlineKey> -->
      <!-- <CreateDateFrom>2024-01-01T00:00:00</CreateDateFrom> -->
      <!-- <CreateDateTo>2024-01-31T23:59:59</CreateDateTo> -->
      <!-- <UpdateDateFrom>2024-05-01T00:00:00</UpdateDateFrom> -->
      <!-- <UpdateDateTo>2024-05-02T00:00:00</UpdateDateTo> -->
      <!-- <CreateAndUpdateDateFrom>2024-05-01T00:00:00</CreateAndUpdateDateFrom> -->
      <!-- <CreateAndUpdateDateTo>2024-05-02T00:00:00</CreateAndUpdateDateTo> -->
      <!-- <RowCount>500</RowCount> -->
    </ns1:pixiReadOrderlines>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

curl -X POST 'https://apigateway.descartes.com/tms/pixi/' \
  --user 'USERNAME:PASSWORD' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --data-binary @- <<'XML'
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://apigateway.descartes.com/tms/pixi/">
  <SOAP-ENV:Body>
    <ns1:pixiReadOrderlines>
      <!-- <OrderlineKey>0</OrderlineKey> -->
      <!-- <CreateDateFrom>2024-01-01T00:00:00</CreateDateFrom> -->
      <!-- <CreateDateTo>2024-01-31T23:59:59</CreateDateTo> -->
      <!-- <UpdateDateFrom>2024-05-01T00:00:00</UpdateDateFrom> -->
      <!-- <UpdateDateTo>2024-05-02T00:00:00</UpdateDateTo> -->
      <!-- <CreateAndUpdateDateFrom>2024-05-01T00:00:00</CreateAndUpdateDateFrom> -->
      <!-- <CreateAndUpdateDateTo>2024-05-02T00:00:00</CreateAndUpdateDateTo> -->
      <!-- <RowCount>500</RowCount> -->
    </ns1:pixiReadOrderlines>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML

<?php

$soapClient = new SoapClient(null, [
    'login' => 'USERNAME',
    'password' => 'PASSWORD',
    'location' => 'https://apigateway.descartes.com/tms/pixi/',
    'uri' => 'https://apigateway.descartes.com/tms/pixi/',
]);

$arguments = [
    // 'OrderlineKey' => '0',
    // 'CreateDateFrom' => '2024-01-01T00:00:00',
    // 'CreateDateTo' => '2024-01-31T23:59:59',
    // 'UpdateDateFrom' => '2024-05-01T00:00:00',
    // 'UpdateDateTo' => '2024-05-02T00:00:00',
    // 'CreateAndUpdateDateFrom' => '2024-05-01T00:00:00',
    // 'CreateAndUpdateDateTo' => '2024-05-02T00:00:00',
    // 'RowCount' => '500',
];

$soapArguments = [];
foreach ($arguments as $name => $value) {
    $soapArguments[] = new SoapVar($value, XSD_STRING, '', '', $name);
}

$response = $soapClient->__soapCall('pixiReadOrderlines', $soapArguments);

Verwendete Tabellen

Orderlines · Lesen OrderHeader · Lesen ExchRate · Lesen Currency · Lesen Orderline_EstimatedDelivery · Lesen

SQL-Objekt:: dbo.pipiReadOrderlines