pixiGetOrderHeader

Liefert Auftragsköpfe mit Kunden-, Rechnungs- und Lieferadress-, Rechnungs-, Versand-, Gutschein- und Tag-Daten, ausgewählt über Auftragsnummer, externe Auftragsnummer oder Filter.

Der Aufruf wählt Auftragsköpfe in einem von drei Modi aus und liefert eine Zeile je Auftrag.

Normalisierung der Parameter

• OrderNr = 0, CustKey = 0 sowie leere Zeichenketten für OrderNrExternal, ShopID, PaymentType, ShippingCountry gelten als nicht gesetzt.
• Datumsparameter (FromTime, UntilTime, FromUpdateTime), die mehr als 100 Jahre in der Vergangenheit liegen (z. B. 1900-01-01), gelten als nicht gesetzt.
• RowCount = NULL wird zu 1000.

Auswahlmodi (die erste zutreffende Regel gilt)

1. OrderNr gesetzt: der Auftrag mit dieser OrderNr. Optional eingeschränkt über CustKey und ShopID (CustomerOf des Kunden). Alle anderen Filter werden ignoriert.

2. OrderNrExternal gesetzt: Aufträge mit dieser externen Auftragsnummer, optional eingeschränkt über CustKey und ShopID. Alle anderen Filter werden ignoriert.

3. Einer der Parameter FromTime, UntilTime, ShopID, PaymentType, ShippingCountry, CustKey, FromUpdateTime gesetzt: Filtersuche, UND-verknüpft:

   • OrderDate > FromTime und OrderDate < UntilTime (jeweils exklusiv)
   • UpdateDate > FromUpdateTime (exklusiv)
   • CustRef = CustKey
   • CustomerOf des Kunden = ShopID
   • Land der Lieferadresse = ShippingCountry
   • Zahlungsart (APayment) der Rechnungsadresse = PaymentType

   Es werden höchstens RowCount Aufträge übernommen, älteste CreateDate zuerst.

4. Kein Parameter gesetzt: Es wird ein leeres Ergebnis geliefert (Abwärtskompatibilität).

Gelieferte Daten

• Kopffelder des Auftrags, Kundendaten, Zahlungs-/Bankdaten der Rechnungsadresse sowie Name und Anschrift der Lieferadresse.
• Aggregate über die Auftragspositionen: Shipdate/LastShipdate (frühestes/spätestes ScanOutDate der verknüpften Rechnungen), TrackingID, ShipVendor, LastInvoiceNr (höchste Rechnungsnummer), VoucherID (höchste Gutschein-ID der Positionen) mit VoucherAmount aus der Gutscheintabelle, EstimatedDelivery (spätester voraussichtlicher Liefertermin) und TotalDiscount (Summe aus DiscountValue × Qty für Positionen, die nicht im Status STO oder NLB sind).
• Berücksichtigt werden nur Rechnungen, die keine Gutschriften sind (ohne Verweis auf eine andere Rechnung). Positionen im Status MIN werden immer berücksichtigt, andere nur bei Rechnungspositionsmenge > 0 oder ohne Rechnungsposition.
• Gender wird aus der Anrede der Lieferadresse abgeleitet: 1 für Herr, Hr., M., Monsieur, Mr, Mr.; 2 für Mrs, Mrs., Ms, Ms., Frau, Fr.; sonst 0.
• Tags enthält die Namen der Tags des Auftrags, nach Name sortiert und durch | getrennt.

Die Zeilen sind nach CreateDate aufsteigend sortiert und auf RowCount begrenzt. Passt kein Auftrag, wird eine leere Ergebnismenge mit denselben Spalten geliefert.

Parameter

Antwort

Result-Set 1 · Immer; leer (gleiche Spalten), wenn kein Auftrag passt oder kein Auswahlparameter gesetzt ist.

Eine Zeile je Auftrag, nach CreateDate aufsteigend sortiert, höchstens RowCount Zeilen.

<SqlRowSet1>
  <row>
    <OrderHeaderKey>48211</OrderHeaderKey>
    <OrderNr>100234</OrderNr>
    <CreateDate>2024-05-14T10:22:31</CreateDate>
    <OrderNrExternal>SHOP-2024-004711</OrderNrExternal>
    <OrderTotal>89.9000</OrderTotal>
    <OrderlinesTotal>84.9000</OrderlinesTotal>
    <WholeOrderState>AUF</WholeOrderState>
    <Shipdate>2024-05-15T14:03:12</Shipdate>
    <LastShipdate>2024-05-15T14:03:12</LastShipdate>
    <TrackingID>00340434161094015902</TrackingID>
    <ShipVendor>DHL</ShipVendor>
    <ShopID>SHP</ShopID>
    <OrderDate>2024-05-14T10:20:00</OrderDate>
    <ShipCost>5.0000</ShipCost>
    <PaymentAddressId>77120</PaymentAddressId>
    <ShipmentAddressId>77121</ShipmentAddressId>
    <PaymentType>V</PaymentType>
    <Account/>
    <Blz/>
    <CustKey>5821</CustKey>
    <SalutationText>Frau</SalutationText>
    <Gender>2</Gender>
    <LastName>Müller</LastName>
    <FirstName>Anna</FirstName>
    <ShippingCountry>DE</ShippingCountry>
    <ZIP>80331</ZIP>
    <City>München</City>
    <Street>Marienplatz</Street>
    <HouseNr>1</HouseNr>
    <CustomerNr>10025821</CustomerNr>
    <OrderCurrency>EUR</OrderCurrency>
    <OrderTotal_OrderCurr>89.9000</OrderTotal_OrderCurr>
    <CustomerEmail>anna.mueller@example.com</CustomerEmail>
    <OrderLocked>N</OrderLocked>
    <LastInvoiceNr>RE240512</LastInvoiceNr>
    <TotalDiscount>0.0000</TotalDiscount>
    <OrderType>STD</OrderType>
    <Tags>Express|VIP</Tags>
  </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:pixiGetOrderHeader>
      <!-- <OrderNr>100234</OrderNr> -->
      <!-- <OrderNrExternal>SHOP-2024-004711</OrderNrExternal> -->
      <!-- <CustKey>5821</CustKey> -->
      <!-- <FromTime>2024-05-01T00:00:00</FromTime> -->
      <!-- <UntilTime>2024-06-01T00:00:00</UntilTime> -->
      <!-- <ShopID>SHP</ShopID> -->
      <!-- <PaymentType>V</PaymentType> -->
      <!-- <ShippingCountry>DE</ShippingCountry> -->
      <!-- <RowCount>500</RowCount> -->
      <!-- <FromUpdateTime>2024-05-15T08:30:00</FromUpdateTime> -->
    </ns1:pixiGetOrderHeader>
  </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:pixiGetOrderHeader>
      <!-- <OrderNr>100234</OrderNr> -->
      <!-- <OrderNrExternal>SHOP-2024-004711</OrderNrExternal> -->
      <!-- <CustKey>5821</CustKey> -->
      <!-- <FromTime>2024-05-01T00:00:00</FromTime> -->
      <!-- <UntilTime>2024-06-01T00:00:00</UntilTime> -->
      <!-- <ShopID>SHP</ShopID> -->
      <!-- <PaymentType>V</PaymentType> -->
      <!-- <ShippingCountry>DE</ShippingCountry> -->
      <!-- <RowCount>500</RowCount> -->
      <!-- <FromUpdateTime>2024-05-15T08:30:00</FromUpdateTime> -->
    </ns1:pixiGetOrderHeader>
  </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 = [
    // 'OrderNr' => '100234',
    // 'OrderNrExternal' => 'SHOP-2024-004711',
    // 'CustKey' => '5821',
    // 'FromTime' => '2024-05-01T00:00:00',
    // 'UntilTime' => '2024-06-01T00:00:00',
    // 'ShopID' => 'SHP',
    // 'PaymentType' => 'V',
    // 'ShippingCountry' => 'DE',
    // 'RowCount' => '500',
    // 'FromUpdateTime' => '2024-05-15T08:30:00',
];

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

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

Verwendete Tabellen

SQL-Objekt:

dbo.pipiGetOrderHeader

Prozedur zuletzt geändert am 2026-10-05

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