pixiSetOrderShippingLock

Setzt oder entfernt die Versandsperre eines Auftrags über dessen Lieferadresse und schreibt einen Eintrag in die Versandsperren-Historie.

Setzt die Versandsperre (ASlocked) an der Lieferadresse eines Auftrags.

1. Locked = NULL wird als 1 behandelt; ein leerer oder NULL-UserName wird zu API.
2. Die Referenz auf die Lieferadresse (ShipAdrRef) wird aus OrderHeader zum OrderNr gelesen. Existiert der Auftrag nicht oder ist ShipAdrRef NULL, wird eine ERROR-Zeile geliefert.
3. Der referenzierte Datensatz in Addresses wird nur ausgewählt, wenn er AddrType = 'S' hat und sein aktueller ASlocked-Wert vom Zielwert abweicht (Y für Sperren, N für Entsperren). Wird keine solche Adresse gefunden, wird eine INFO-Zeile geliefert und nichts geändert.
4. Ist Reason leer oder NULL, wird der Text Order was locked by {UserName} bzw. Order was unlocked by {UserName} verwendet.
5. Ein Datensatz wird in pixi.AddressesShippingLockHistory eingefügt. Er enthält die Benutzer-ID, den Adressschlüssel, das Sperrkennzeichen und den Grund. Die Benutzer-ID wird aus UserName über inf.UserGetByName ermittelt, bei unbekanntem Namen wird der Benutzer pixiAdministration verwendet.
6. Die Adresse wird aktualisiert:
   • ASlocked wird auf Y/N gesetzt.
   • UpdateDate wird auf die aktuelle Zeit gesetzt.
   • UpdateEmp wird auf den Benutzernamen gesetzt. Der Standardwert API wird als API SetOrderShippingLock geschrieben.
7. Eine OK-Zeile wird geliefert.

Parameter

Antwort

Result-Set 1 · Wenn kein Auftrag mit OrderNr existiert (oder er keine Lieferadressreferenz hat)

Fehler-Statuszeile.

Result-Set 2 · Wenn die Lieferadresse bereits den Zielzustand hat, nicht existiert oder nicht vom Typ S ist

Informations-Statuszeile; es wird nichts geändert.

Result-Set 3 · Bei Erfolg

Erfolgs-Statuszeile, nachdem der Historieneintrag geschrieben und die Adresse aktualisiert wurde.

<SqlRowSet1>
  <row>
    <ReturnCode>OK</ReturnCode>
    <ErrorMessage>Order with OrderNr 104523 changed. </ErrorMessage>
  </row>
</SqlRowSet1>

Fehlermeldungen

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:pixiSetOrderShippingLock>
      <OrderNr>104523</OrderNr>
      <!-- <Locked>1</Locked> -->
      <!-- <UserName>shopsync</UserName> -->
      <!-- <Reason>Payment not yet received</Reason> -->
    </ns1:pixiSetOrderShippingLock>
  </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:pixiSetOrderShippingLock>
      <OrderNr>104523</OrderNr>
      <!-- <Locked>1</Locked> -->
      <!-- <UserName>shopsync</UserName> -->
      <!-- <Reason>Payment not yet received</Reason> -->
    </ns1:pixiSetOrderShippingLock>
  </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' => '104523',
    // 'Locked' => '1',
    // 'UserName' => 'shopsync',
    // 'Reason' => 'Payment not yet received',
];

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

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

Verwendete Tabellen

SQL-Objekt:

dbo.pipiSetOrderShippingLock

Prozedur zuletzt geändert am 2026-10-05

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