Orders Schreiben

pixiAddOrderComment

Setzt die Shop-Notiz (`Shop_Note`) eines Auftrags anhand der Auftragsnummer und liefert 1 bei Erfolg oder 0, wenn der Auftrag fehlt oder maskiert ist.

Schreibt einen Kommentar in das Feld für die Shop-Notiz eines Auftrags.

Der Auftrag wird in OrderHeader über OrderNr gesucht. Existiert kein Auftrag, wird eine Zeile mit ReturnMessage = 0 geliefert und die Verarbeitung beendet.
Es wird geprüft, ob der Auftrag bearbeitbar ist. Ein Auftrag gilt als nicht bearbeitbar (maskiert), wenn ein Auftragskopf-Attribut vom Typ 2 mit dem Wert 2 vorhanden ist. Bei einem maskierten Auftrag wird ReturnMessage = 0 geliefert und nichts geändert.
Andernfalls wird Shop_Note des Auftrags auf @Comment gesetzt und ReturnMessage = 1 geliefert.

Trotz des Namens wird der Kommentar nicht angehängt: Der bisherige Inhalt von Shop_Note wird vollständig ersetzt.

Hinweise

Die bestehende Shop-Notiz wird überschrieben. Soll bisheriger Text erhalten bleiben, muss die aktuelle Notiz vorher gelesen und der kombinierte Text gesendet werden.
Ist Comment NULL, wird die Notiz auf eine leere Zeichenkette gesetzt (die Blacklist-Funktion ersetzt derzeit nur NULL durch '').
ReturnMessage = 0 unterscheidet nicht zwischen "Auftrag nicht gefunden" und "Auftrag maskiert".
Das Lesen des Auftrags und seiner Attribute erfolgt mit NOLOCK.
Das Update läuft in einer eigenen Transaktion bzw. in einem Savepoint, falls bereits eine Transaktion offen ist. Bei einem Fehler wird zurückgerollt und der Fehler über log.InsertError protokolliert (Definition nicht beigefügt); in diesem Fall liefert die Prozedur keine ReturnMessage-Zeile, und ob ein Fehler an den Aufrufer weitergegeben wird, hängt von log.InsertError ab.
Die Suche des Auftrags über OrderNr liegt außerhalb der Fehlerbehandlung; gäbe es mehrere Aufträge mit derselben OrderNr, würde die Unterabfrage mit einem SQL-Fehler abbrechen.

Parameter

Parameter	Typ	Standardwert	Beschreibung
`OrderNr` Pflicht	int	–	Auftragsnummer des Auftrags, dessen Shop-Notiz gesetzt wird. Beispiel: `100245`
`Comment` Pflicht	nvarchar(max) string	–	Text, der in `Shop_Note` geschrieben wird. Ersetzt die bisherige Notiz vollständig; `NULL` ergibt eine leere Notiz. Beispiel: `Customer requests delivery after 2 pm.`

Antwort

Result-Set 1 · Immer, sofern beim Update kein Fehler auftritt

Einzelne Statuszeile, die angibt, ob die Notiz geschrieben wurde.

Spalte	Typ	Beschreibung
`ReturnMessage`	int	`1` = Shop-Notiz aktualisiert; `0` = Auftrag nicht gefunden oder Auftrag maskiert (nicht bearbeitbar).

Beispielantwort

<SqlRowSet1>
  <row>
    <ReturnMessage>1</ReturnMessage>
  </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:pixiAddOrderComment>
      <OrderNr>100245</OrderNr>
      <Comment>Customer requests delivery after 2 pm.</Comment>
    </ns1:pixiAddOrderComment>
  </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:pixiAddOrderComment>
      <OrderNr>100245</OrderNr>
      <Comment>Customer requests delivery after 2 pm.</Comment>
    </ns1:pixiAddOrderComment>
  </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' => '100245',
    'Comment' => 'Customer requests delivery after 2 pm.',
];

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

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

Verwendete Tabellen

OrderHeader · Schreiben OrderHeaderAttribute · Lesen

SQL-Objekt:: dbo.pipiAddOrderComment