pixiUpdateInvoicePackageTrackingIds

Setzt Sendungs- und Retouren-Tracking-IDs einer Rechnung und, falls eindeutig bestimmbar, des zugehörigen Rechnungspakets und publiziert ein `InvoiceChanged`-Event.

Aktualisiert Tracking-Informationen einer Rechnung (Invoices) und ihres Pakets (pixi.InvoicePackage). Als Ergebnis wird immer eine Statuszeile mit Status und Message geliefert.

Prüfungen

• Mindestens einer der Werte PackageId oder InvoiceNr und mindestens einer der Werte TrackingId oder ReturnTrackingId muss gefüllt sein. Andernfalls wird Status 400 geliefert. Eine PackageId von 0 gilt als leer.
• Bei TrackingId und ReturnTrackingId wird je ein führendes und ein abschließendes ; entfernt.

Ermittlung von Rechnung und Paket

• Mit InvoiceNr wird die Rechnung über die Rechnungsnummer gelesen. Alle Pakete mit Id = PackageId oder zur Rechnung gehörend werden geladen.
• Nur mit PackageId wird das Paket geladen und die zugehörige Rechnung gelesen.
• Wird nur InvoiceNr übergeben, hat die Rechnung mehrere Pakete und ist Overwrite = 1, wird Status 400 geliefert (PackageId ist erforderlich).
• Wird kein Paket gefunden, wird Status 400 geliefert. Das gilt auch, wenn die Rechnung nicht existiert oder kein Paket hat. Gleiches gilt, wenn PackageId und InvoiceNr beide übergeben werden, das Paket aber nicht zur Rechnung gehört.
• Überschreitet die Länge aus gespeichertem und neuem Wert 512 Zeichen, wird Status 411 geliefert. Geprüft wird dies für ShipmentTrackingID und für retTrackIDhist.

Welche Datensätze aktualisiert werden

• Die Rechnung wird immer aktualisiert.
• Das Paket wird in drei Fällen zusätzlich aktualisiert:
  • PackageId und InvoiceNr passen zusammen.
  • Nur InvoiceNr wird übergeben und die Rechnung hat genau ein Paket.
  • Nur PackageId wird übergeben.
• Wird nur InvoiceNr übergeben, hat die Rechnung mehrere Pakete und ist Overwrite = 0, wird nur die Rechnung aktualisiert.

Sendungs-Tracking (TrackingId)

• Overwrite = 0: TrackingId wird mit ; getrennt an Invoices.ShipmentTrackingID angehängt. Das geschieht nur, wenn der bestehende Wert sie noch nicht enthält (Teilstring-Vergleich).
• Overwrite = 1: ShipmentTrackingID wird neu gebildet aus den Tracking-IDs aller anderen Pakete der Rechnung, jeweils gefolgt von ;, plus TrackingId. Ist TrackingId bereits in dieser Liste enthalten, wird ShipmentTrackingID auf TrackingId allein gesetzt.
• Das Paket erhält nur das letzte ;-getrennte Segment von TrackingId als TrackingID.

Retouren-Tracking (ReturnTrackingId)

• Overwrite hat auf das Retouren-Tracking keinen Einfluss.
• Ist ReturnTrackingId noch nicht in Invoices.retTrackID enthalten:
  • retTrackID wird auf das letzte ;-getrennte Segment gesetzt.
  • Der vollständige Wert wird mit abschließendem ; an retTrackIDhist angehängt.
• Das Paket erhält das letzte Segment als ReturnTrackingId.

Weitere Schritte

• Die Rechnung erhält UpdateDate = GETDATE() und UpdateEmp = '(Return) TrackingID API Update'.
• Das Paket erhält RecordModifiedOn und RecordModifiedByUserId, die ID des Benutzers API.
• Mit ResetClientNotifiedFlag = 1 wird ClientNotified auf N gesetzt, und zwar beim jeweils letzten AUS-Eintrag (ausgeliefert) in OrderHistory jeder Auftragsposition der Rechnung. Dadurch wird die Sendung erneut exportiert bzw. gemeldet.
• Zum Schluss wird das MQ-Event InvoiceChanged mit dem Rechnungsschlüssel und dem Parameter SetTrackingId publiziert.

Parameter

Antwort

Result-Set 1 · Immer, außer bei einem unerwarteten SQL-Fehler

Statuszeile mit dem Ergebnis der Aktualisierung.

<SqlRowSet1>
  <row>
    <Status>200</Status>
    <Message>TrackingId &amp; ReturnTrackingId was updated successfully</Message>
  </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:pixiUpdateInvoicePackageTrackingIds>
      <!-- <PackageId>15832</PackageId> -->
      <!-- <InvoiceNr>RE2024001234</InvoiceNr> -->
      <!-- <TrackingId>00340434161094042557</TrackingId> -->
      <!-- <ReturnTrackingId>00340434161094042564</ReturnTrackingId> -->
      <!-- <Overwrite>0</Overwrite> -->
      <!-- <ResetClientNotifiedFlag>1</ResetClientNotifiedFlag> -->
    </ns1:pixiUpdateInvoicePackageTrackingIds>
  </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:pixiUpdateInvoicePackageTrackingIds>
      <!-- <PackageId>15832</PackageId> -->
      <!-- <InvoiceNr>RE2024001234</InvoiceNr> -->
      <!-- <TrackingId>00340434161094042557</TrackingId> -->
      <!-- <ReturnTrackingId>00340434161094042564</ReturnTrackingId> -->
      <!-- <Overwrite>0</Overwrite> -->
      <!-- <ResetClientNotifiedFlag>1</ResetClientNotifiedFlag> -->
    </ns1:pixiUpdateInvoicePackageTrackingIds>
  </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 = [
    // 'PackageId' => '15832',
    // 'InvoiceNr' => 'RE2024001234',
    // 'TrackingId' => '00340434161094042557',
    // 'ReturnTrackingId' => '00340434161094042564',
    // 'Overwrite' => '0',
    // 'ResetClientNotifiedFlag' => '1',
];

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

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

Verwendete Tabellen

SQL-Objekt:

dbo.pipiUpdateInvoicePackageTrackingIds

Prozedur zuletzt geändert am 2026-10-05

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