Orderlines Lesen

pixiCanCancelOrderline2

Liefert den Status einer Auftragsposition und ein Kennzeichen, ob die Auftragsposition noch storniert werden kann.

Prüft, ob eine einzelne Auftragsposition storniert werden kann, und liefert dazu eine Zeile.

Die in OrderlineKey angegebene Auftragsposition wird aus Orderlines gelesen und über den Statuscode mit OrderStates verknüpft. Die Zeile enthält den Schlüssel der Auftragsposition, den Statuscode, den Statustext und das Kennzeichen CanCancel.

CanCancel ist nur dann 1, wenn alle folgenden Bedingungen erfüllt sind:

der Status ist kein Endstatus (FinalState des Status ist N oder leer),
der Status ist nicht EIN,
die Auftragsposition wird in BoxItems nicht referenziert (es gibt keinen Box-Eintrag zu ihr),
die Auftragsposition wird in InvLines nicht referenziert (sie ist noch nicht berechnet).

In allen anderen Fällen ist CanCancel gleich 0.

Der Aufruf führt nur eine Prüfung durch. Es wird nichts storniert und es werden keine Daten geändert.

Hinweise

Alle Tabellen werden WITH (NOLOCK) gelesen. Das Ergebnis kann nicht festgeschriebene Änderungen enthalten; daher empfiehlt sich eine erneute Prüfung unmittelbar vor der Stornierung.
Die Ergebnismenge ist leer, wenn die Auftragsposition nicht existiert oder ihr Statuscode keinen Eintrag in OrderStates hat (Inner Join).
Die Prüfungen gegen BoxItems und InvLines verwenden NOT IN-Unterabfragen. Enthält eine dieser Tabellen eine Zeile mit leerer (NULL) Referenz auf die Auftragsposition, ist die Bedingung nie erfüllt und CanCancel ist für jede Auftragsposition 0.

Parameter

Parameter	Typ	Standardwert	Beschreibung
`OrderlineKey` Pflicht	int	–	Schlüssel der zu prüfenden Auftragsposition (`Orderlines.OrderlineKey`). Beispiel: `123456`

Antwort

Result-Set 1 · Wenn die Auftragsposition existiert und ihr Status in `OrderStates` vorhanden ist; sonst leer.

Eine Zeile mit dem Status der Auftragsposition und dem Stornierungskennzeichen.

Spalte	Typ	Beschreibung
`OrderlineKey`	int	Schlüssel der Auftragsposition.
`Status`	string	Aktueller Statuscode der Auftragsposition.
`StateText` Kann leer sein	string	Text des Status aus `OrderStates`.
`CanCancel`	int	`1`, wenn die Auftragsposition storniert werden kann, sonst `0`.

Beispielantwort

<SqlRowSet1>
  <row>
    <OrderlineKey>123456</OrderlineKey>
    <Status>AUF</Status>
    <StateText>Auftrag angelegt</StateText>
    <CanCancel>1</CanCancel>
  </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:pixiCanCancelOrderline2>
      <OrderlineKey>123456</OrderlineKey>
    </ns1:pixiCanCancelOrderline2>
  </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:pixiCanCancelOrderline2>
      <OrderlineKey>123456</OrderlineKey>
    </ns1:pixiCanCancelOrderline2>
  </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('pixiCanCancelOrderline2', $soapArguments);

Verwendete Tabellen

Orderlines · Lesen OrderStates · Lesen BoxItems · Lesen InvLines · Lesen

SQL-Objekt:: dbo.pipiCanCancelOrderline2