Orderlines Lesen

pixiGetOrderlineHistory

Liefert die Statushistorie einer einzelnen Auftragsposition in chronologischer Reihenfolge.

Liest alle Einträge aus der Tabelle orderhistory, die zur in OrderlineKey angegebenen Auftragsposition gehören (Spalte OrderLineRef).

Für jede Statusänderung werden geliefert:

das Datum der Änderung,
der gesetzte Status,
der Benutzer, der die Änderung vorgenommen hat,
ob der Kunde benachrichtigt wurde,
der Schlüssel des Historieneintrags.

Die Zeilen sind nach StatusChangeDate aufsteigend sortiert, der älteste Eintrag steht zuerst. Hat die Auftragsposition keine Historieneinträge oder existiert sie nicht, wird eine leere Ergebnismenge geliefert.

Hinweise

Die Tabelle wird mit NOLOCK gelesen, daher können nicht festgeschriebene Änderungen sichtbar sein.
Bei einem unbekannten Positionsschlüssel wird kein Fehler gemeldet; die Ergebnismenge ist dann leer.
Die Spalte UpdateEmp wird als UpdateUser und OrderHistKey als OrderlineHistKey ausgegeben.

Parameter

Parameter	Typ	Standardwert	Beschreibung
`OrderlineKey` Pflicht	int	–	Schlüssel der Auftragsposition, deren Statushistorie geliefert wird (Abgleich mit `OrderLineRef` in `orderhistory`). Beispiel: `123456`

Antwort

Result-Set 1 · Immer; leer, wenn für die Auftragsposition keine Historieneinträge existieren.

Eine Zeile pro Statusänderung der Auftragsposition, älteste zuerst.

Spalte	Typ	Beschreibung
`StatusChangeDate` Kann leer sein	dateTime	Datum und Uhrzeit der Statusänderung.
`Status` Kann leer sein	string	Durch diese Änderung gesetzter Status der Auftragsposition.
`UpdateUser` Kann leer sein	string	Benutzer, der die Änderung vorgenommen hat (Spalte `UpdateEmp`).
`ClientNotified` Kann leer sein	string	Gibt an, ob der Kunde über die Statusänderung benachrichtigt wurde.
`OrderlineHistKey`	int	Schlüssel des Historieneintrags (Spalte `OrderHistKey`).

Beispielantwort

<SqlRowSet1>
  <row>
    <StatusChangeDate>2024-03-11T09:15:22</StatusChangeDate>
    <Status>AUF</Status>
    <UpdateUser>API</UpdateUser>
    <ClientNotified>0</ClientNotified>
    <OrderlineHistKey>987001</OrderlineHistKey>
  </row>
  <row>
    <StatusChangeDate>2024-03-12T14:02:10</StatusChangeDate>
    <Status>AUS</Status>
    <UpdateUser>lager01</UpdateUser>
    <ClientNotified>1</ClientNotified>
    <OrderlineHistKey>987245</OrderlineHistKey>
  </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:pixiGetOrderlineHistory>
      <OrderlineKey>123456</OrderlineKey>
    </ns1:pixiGetOrderlineHistory>
  </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:pixiGetOrderlineHistory>
      <OrderlineKey>123456</OrderlineKey>
    </ns1:pixiGetOrderlineHistory>
  </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' => '123456',
];

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

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

Verwendete Tabellen

orderhistory · Lesen

SQL-Objekt:: dbo.pipiGetOrderlineHistory