Customers Schreiben

pixiAddCustomerComment

Setzt das Kommentarfeld `CHisNote` eines über die externe Kundennummer ermittelten Kunden und liefert 1 bei Erfolg bzw. 0, wenn kein Kunde gefunden wurde.

Schreibt einen Kommentar in die Spalte CHisNote eines Kundendatensatzes.

Die Prozedur prüft, ob in Customers ein Kunde mit CustomerNrExternal = CustomerNrExternal existiert.
Wird ShopID übergeben, werden nur Kunden mit CustomerOf = ShopID berücksichtigt. Ohne ShopID (NULL) erfolgt keine Prüfung des Shops.
Existiert kein passender Kunde, liefert der Aufruf eine Zeile mit ReturnMessage = 0. Es wird nichts geändert.
Andernfalls wird CHisNote aller passenden Kunden auf Comment gesetzt und der Aufruf liefert eine Zeile mit ReturnMessage = 1.

Hinweise

Entgegen dem Namen und dem Kopfkommentar ("manuelles Buchungsereignis anlegen") wird kein neuer Eintrag angelegt. Der bestehende Inhalt von CHisNote wird überschrieben. Ein vorhandener Kommentar geht verloren, sofern er nicht in Comment mitgegeben wird.
Wird ShopID weggelassen und existiert dieselbe externe Kundennummer in mehreren Shops, wird der Kommentar bei all diesen Kunden geschrieben.
Die Existenzprüfung liest mit NOLOCK. Prüfung und Update laufen nicht in einer expliziten Transaktion.
Existiert der Kunde und wird Comment weggelassen, wird CHisNote auf NULL gesetzt, da Comment keinen Standardwert hat.

Parameter

Parameter	Typ	Standardwert	Beschreibung
`CustomerNrExternal` Pflicht	varchar(250) string	–	Externe Kundennummer (`Customers.CustomerNrExternal`) des zu aktualisierenden Kunden. Beispiel: `K-100234`
`Comment` Pflicht	ntext string	–	Kommentartext. Er ersetzt den aktuellen Inhalt von `CHisNote`. Beispiel: `Customer requested delivery only after 2 pm.`
`ShopID`	varchar(3) string	NULL	Optionale Shop-ID (`Customers.CustomerOf`). Wenn gesetzt, werden nur Kunden dieses Shops berücksichtigt. Bei `NULL` werden Kunden aller Shops berücksichtigt. Beispiel: `SHP`

Antwort

Result-Set 1 · Immer (genau eine Zeile)

Ergebniskennzeichen des Aufrufs.

Spalte	Typ	Beschreibung
`ReturnMessage`	int	`1`, wenn der Kommentar geschrieben wurde, `0`, wenn kein passender Kunde gefunden wurde.

Beispielantwort

<SqlRowSet1>
  <row>
    <ReturnMessage>1</ReturnMessage>
  </row>
</SqlRowSet1>

Fehlermeldungen

Status	Meldung	Ursache
ReturnMessage = 0	0	Es existiert kein Kunde mit der angegebenen `CustomerNrExternal`, oder keiner gehört zur angegebenen `ShopID`. Externe Kundennummer und Shop-ID prüfen oder `ShopID` weglassen.

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:pixiAddCustomerComment>
      <CustomerNrExternal>K-100234</CustomerNrExternal>
      <Comment>Customer requested delivery only after 2 pm.</Comment>
      <!-- <ShopID>SHP</ShopID> -->
    </ns1:pixiAddCustomerComment>
  </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:pixiAddCustomerComment>
      <CustomerNrExternal>K-100234</CustomerNrExternal>
      <Comment>Customer requested delivery only after 2 pm.</Comment>
      <!-- <ShopID>SHP</ShopID> -->
    </ns1:pixiAddCustomerComment>
  </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 = [
    'CustomerNrExternal' => 'K-100234',
    'Comment' => 'Customer requested delivery only after 2 pm.',
    // 'ShopID' => 'SHP',
];

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

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

Verwendete Tabellen

Customers · Schreiben

SQL-Objekt:: dbo.pipiAddCustomerComment