pixiGetOrderHeaderList

Liefert Kopfdaten für mehrere Aufträge anhand ihrer externen Auftragsnummern, inklusive Kunden-, Adress-, Zahlungs-, Versand- und Rechnungsinformationen.

Erwartet eine Liste externer Auftragsnummern (OrderNrExternal) als XML und liefert je passendem Auftrag aus OrderHeader eine Zeile.

Ablauf:

1. Das XML wird in Werte zerlegt. Gelesen wird jedes Kindelement des Wurzelelements, unabhängig vom Elementnamen. Doppelte Werte werden entfernt.
2. Ist die Liste leer, gibt die Prozedur No Data! per PRINT aus und liefert kein Resultset.
3. Zwei Einstellungen werden gelesen:
   • UseInitialOrderDate: bei 1 ist OrderDate das früheste Bestelldatum der Auftragspositionen, sonst das späteste.
   • NumberOfDecimalPlacesForPrices: Anzahl Nachkommastellen für die Rundung von Qty * Price je Position (Standard 2, wenn die Einstellung fehlt oder 0 ist).
4. Aufträge werden über OrderHeader.OrderNrExternal gefunden. Externe Nummern ohne passenden Auftrag werden ohne Hinweis übergangen.
5. Ein Auftrag wird nur geliefert, wenn Währung, Kunde, Rechnungsadresse (AddrRef) und Lieferadresse (ShipAdrRef) vorhanden sind. Diese Verknüpfungen sind Inner Joins.
6. Je Auftrag werden die Auftragspositionen zusammen mit ihren Rechnungspositionen, ihren Rechnungen (nur Rechnungen mit RefToInvoiceKey IS NULL) und ihren voraussichtlichen Lieferterminen aggregiert:
   • Versanddaten (min./max. ScanOutDate), Tracking-ID, Versanddienstleister, letzte Rechnungsnummer;
   • Paid/PayedSum aus den Rechnungen;
   • OrderTotal_OrderCurr = Summe der gerundeten Werte Qty * Price aller Positionen außer Status STO und NLB, plus ShipCost, minus Discount.
7. Gender wird aus der Anrede (Anrede) der Lieferadresse abgeleitet:
   • 1 für Herr, Hr., M., Monsieur, Mr, Mr.
   • 2 für Mrs, Mrs., Ms, Ms., Frau, Fr.
   • 0 für alle anderen Werte.

Die Sortierung erfolgt nach CreateDate aufsteigend.

Parameter

<x>
  <i>SHOP-100234</i>
  <i>SHOP-100235</i>
</x>

Antwort

Result-Set 1 · Wenn das XML mindestens einen Wert enthält; kann null Zeilen haben, wenn kein Auftrag passt.

Eine Zeile je passendem Auftrag, sortiert nach CreateDate aufsteigend.

<SqlRowSet1>
  <row>
    <OrderHeaderKey>48211</OrderHeaderKey>
    <OrderNr>100512</OrderNr>
    <CreateDate>2024-03-11T09:14:22</CreateDate>
    <OrderNrExternal>SHOP-100234</OrderNrExternal>
    <OrderTotal>84.90</OrderTotal>
    <OrderlinesTotal>79.90</OrderlinesTotal>
    <WholeOrderState>AUS</WholeOrderState>
    <Shipdate>2024-03-12T14:02:00</Shipdate>
    <LastShipdate>2024-03-12T14:02:00</LastShipdate>
    <TrackingID>00340434161234567890</TrackingID>
    <ShipVendor>DHL</ShipVendor>
    <ShopID>WEB</ShopID>
    <OrderDate>2024-03-11T09:14:22</OrderDate>
    <ShipCost>5.00</ShipCost>
    <PaymentAddressId>70211</PaymentAddressId>
    <ShipmentAddressId>70212</ShipmentAddressId>
    <PaymentType>PayPal</PaymentType>
    <VoucherAmount>0.00</VoucherAmount>
    <CustKey>33120</CustKey>
    <SalutationText>Frau</SalutationText>
    <Gender>2</Gender>
    <LastName>Muster</LastName>
    <FirstName>Anna</FirstName>
    <ShippingCountry>DE</ShippingCountry>
    <ZIP>80331</ZIP>
    <City>München</City>
    <Street>Marienplatz 1</Street>
    <CustomerNr>10045</CustomerNr>
    <OrderCurrency>EUR</OrderCurrency>
    <OrderTotal_OrderCurr>84.90</OrderTotal_OrderCurr>
    <Paid>true</Paid>
    <PayedSum>84.90</PayedSum>
    <CustomerEmail>anna.muster@example.com</CustomerEmail>
    <CustomerNrExternal>C-55812</CustomerNrExternal>
    <OrderLocked>N</OrderLocked>
    <LastInvoiceNr>200781</LastInvoiceNr>
  </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:pixiGetOrderHeaderList>
      <OrderNrExternalXml><![CDATA[<x><i>SHOP-100234</i><i>SHOP-100235</i></x>]]></OrderNrExternalXml>
    </ns1:pixiGetOrderHeaderList>
  </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:pixiGetOrderHeaderList>
      <OrderNrExternalXml><![CDATA[<x><i>SHOP-100234</i><i>SHOP-100235</i></x>]]></OrderNrExternalXml>
    </ns1:pixiGetOrderHeaderList>
  </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 = [
    'OrderNrExternalXml' => '<x><i>SHOP-100234</i><i>SHOP-100235</i></x>',
];

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

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

Verwendete Tabellen

SQL-Objekt:

dbo.pipiGetOrderHeaderList

Prozedur zuletzt geändert am 2026-10-05

Dokumentation von claude-opus-5-5 am 2026-10-30 geschrieben