pixiShipoutInvoice

Führt den Versand (Ausscannen) einer Rechnung oder einer Box durch: aktualisiert Pakete, Versender, Gewicht und Tracking-IDs und gibt Bestand frei.

Führt den vollständigen Versand (Ausscannen) einer Rechnung per API durch, identifiziert über InvoiceNr, über BoxNr oder über beide.

Vorbereitung und Prüfungen

• BoxNr = 0 wird wie NULL behandelt. InvoiceNr, TrackingID und ShipVendorCode werden getrimmt; leere Werte werden zu NULL.
• Die Einstellung Centralized_Ship_Out oder Premium_API muss aktiv sein.
• Mindestens einer der Parameter InvoiceNr / BoxNr ist erforderlich.
• LocID muss in Location existieren; eine angegebene BoxNr muss in boxes existieren (an beliebigem Lager).
• Die Rechnung wird über InvoiceNr am Lager LocID gesucht und zusätzlich über die Auftragspositionen in der Box BoxNr an diesem Lager. Berücksichtigt werden nur Rechnungspositionen, deren Auftragsposition nicht den Status MIN hat. Die Box ergibt sich aus den Boxpositionen dieser Auftragspositionen.
• Wird keine Rechnung gefunden, wird No invoice found geliefert. Wird mehr als eine Kombination aus Rechnung/Box gefunden (z. B. Box enthält Positionen mehrerer Rechnungen, Rechnungspositionen liegen in mehreren Boxen oder nur teilweise in einer Box) oder weicht die gefundene Rechnung/Box von der angegebenen ab, wird eine Fehlerzeile geliefert.

Versand

1. Hat die Rechnung einen RefToInvoiceKey, wird Boxnummer -2 verwendet (das anschließende Ausscannen schlägt dann mit 0004. NO BOX !!! fehl). Andernfalls wird eine vorhandene Box am Lager mit den Rechnungspositionen verwendet oder eine neue Box für die Rechnung angelegt. Ist der Kunde oder die Lieferadresse gesperrt oder die Rechnung bereits ausgescannt, ergibt sich eine negative Boxnummer und das Ausscannen schlägt ebenfalls fehl.
2. Die Paketanzahl wird auf AmountOfPackages (mindestens 1) gesetzt; Rechnungspakete werden entsprechend ergänzt oder entfernt.
3. Der Versender wird auf ShipVendorCode gesetzt (bzw. auf den aktuellen Versender der Rechnung, falls nicht angegeben).
4. Die Box wird ausgescannt: Sperr- und Zahlungsprüfung, Ausscannen der Rechnung, Auftragspositionen auf Status AUS, Box geleert, Picklisten-Box-Einträge entfernt, Poll-Datensätze erzeugt.
5. Nur wenn das Ausscannen nicht ERROR liefert:
   • das Gewicht wird auf Rechnung und Pakete geschrieben (nur wenn die Einstellung CalculateWeightFromItems nicht aktiv ist; ohne Weight wird das aktuelle PackageGrossWeight der Rechnung verwendet),
   • TrackingID (semikolongetrennte Liste) wird an den Rechnungspaketen und der Rechnung gespeichert,
   • auf der Pickliste reservierter Bestand wird über die Lagerbewegungsoperation DirectInvoicesWizard der Anwendung ShippingClient_A freigegeben (Benutzer Shipout (API)),
   • bei Direktrechnungen (InvCreationMode = Direct) wird die Box samt Positionen gelöscht.

Der Aufruf liefert genau eine Zeile mit Status und StatusMessage. Bei Erfolg ist Status = OK und StatusMessage leer.

Parameter

Antwort

Result-Set 1 · Immer; genau eine Zeile (Validierungsfehler oder Ergebnis des Ausscannens).

Status des Versands.

<SqlRowSet1>
  <row>
    <Status>OK</Status>
    <StatusMessage/>
  </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:pixiShipoutInvoice>
      <!-- <InvoiceNr>1000234</InvoiceNr> -->
      <!-- <UserName>API</UserName> -->
      <!-- <LocID>001</LocID> -->
      <!-- <BoxNr>4711</BoxNr> -->
      <!-- <Weight>2.35</Weight> -->
      <!-- <AmountOfPackages>1</AmountOfPackages> -->
      <!-- <ShipVendorCode>DHL</ShipVendorCode> -->
      <!-- <TrackingID>00340434161094015902;00340434161094015903</TrackingID> -->
    </ns1:pixiShipoutInvoice>
  </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:pixiShipoutInvoice>
      <!-- <InvoiceNr>1000234</InvoiceNr> -->
      <!-- <UserName>API</UserName> -->
      <!-- <LocID>001</LocID> -->
      <!-- <BoxNr>4711</BoxNr> -->
      <!-- <Weight>2.35</Weight> -->
      <!-- <AmountOfPackages>1</AmountOfPackages> -->
      <!-- <ShipVendorCode>DHL</ShipVendorCode> -->
      <!-- <TrackingID>00340434161094015902;00340434161094015903</TrackingID> -->
    </ns1:pixiShipoutInvoice>
  </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 = [
    // 'InvoiceNr' => '1000234',
    // 'UserName' => 'API',
    // 'LocID' => '001',
    // 'BoxNr' => '4711',
    // 'Weight' => '2.35',
    // 'AmountOfPackages' => '1',
    // 'ShipVendorCode' => 'DHL',
    // 'TrackingID' => '00340434161094015902;00340434161094015903',
];

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

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

Verwandte Calls

Verwendete Tabellen

SQL-Objekt:

dbo.pipiShipoutInvoice

Prozedur zuletzt geändert am 2026-10-05

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