pixiGetInvoicePackage

Liefert die Versandpakete einer Rechnung (Labels, Tracking-IDs, Gewicht, Paketmaße), ausgewählt über Rechnungsnummer, Rechnungs-ID oder Paket-ID.

Liest die zu einer Rechnung gespeicherten Pakete aus pixi.InvoicePackage, zusammen mit dem Code der Paketmaße, der externen Auftragsnummer und der Rechnungsnummer.

Parameterbehandlung und Prüfungen (jede fehlgeschlagene Prüfung liefert eine einzelne Status/Message-Zeile mit Status = Error):

1. Ein leeres InvoiceNumber wird als NULL behandelt. Mindestens einer der Parameter InvoiceNumber, InvoiceId, PackageId muss angegeben werden.
2. InvoiceNumber wird in eine Rechnungs-ID aufgelöst (erster Treffer auf InvoiceNr).
3. Ist InvoiceId oder die aufgelöste ID gesetzt, muss mindestens eine davon in Invoices existieren.
4. Ist PackageId angegeben, muss das Paket existieren.
5. Verweisen InvoiceId und InvoiceNumber auf unterschiedliche Rechnungen, schlägt der Aufruf fehl.
6. Sind Paket und Rechnung angegeben, muss das Paket zu dieser Rechnung gehören.

Auswahl

• Die maßgebliche Rechnung ist InvoiceId, andernfalls die aus InvoiceNumber ermittelte Rechnung.
• Geliefert werden alle Pakete, deren Paket-ID PackageId entspricht oder deren Rechnungs-ID der maßgeblichen Rechnung entspricht. Ist eine Rechnung angegeben, werden alle ihre Pakete geliefert, auch wenn zusätzlich PackageId angegeben ist. Ist nur PackageId angegeben, wird nur dieses Paket geliefert.
• InvoiceNr und OrderNrExternal sind in jeder Zeile gleich. Sie stammen von der Rechnung (direkt angegeben oder über das Paket), die mit Auftragspositionen verknüpft ist: OrderNrExternal kommt vom Auftrag mit der höchsten Order_Id der Rechnungspositionen.
• Eine Sortierung ist nicht festgelegt.

Wird kein Paket gefunden, wird eine Info-Zeile geliefert.

Parameter

Antwort

Result-Set 1 · Bei Erfolg, wenn mindestens ein Paket gefunden wird

Eine Zeile pro gefundenem Rechnungspaket.

Result-Set 2 · Wenn kein Paket zu den Parametern gefunden wird

Info-Zeile statt Paketzeilen.

Result-Set 3 · Wenn eine Parameterprüfung fehlschlägt

Fehlerzeile. Die Prozedur bricht danach ab.

<SqlRowSet1>
  <row>
    <PackageId>4321</PackageId>
    <InvoiceId>98765</InvoiceId>
    <GrossWeight>2.3500</GrossWeight>
    <ShippingLabelUrl>https://labels.example.com/4321.pdf</ShippingLabelUrl>
    <TrackingId>00340434161094042557</TrackingId>
    <TimesLabelPrinted>1</TimesLabelPrinted>
    <ReturnLabelUrl>https://labels.example.com/4321-return.pdf</ReturnLabelUrl>
    <ReturnTrackingId>00340434161094042558</ReturnTrackingId>
    <PackageDimensionId>3</PackageDimensionId>
    <ExternalShipmentId>SHP-778899</ExternalShipmentId>
    <MessageFromProvider>OK</MessageFromProvider>
    <OrderNrExternal>SHOP-100045</OrderNrExternal>
    <InvoiceNr>RE2024-001234</InvoiceNr>
    <PackageDimensionCode>M</PackageDimensionCode>
  </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:pixiGetInvoicePackage>
      <!-- <InvoiceNumber>RE2024-001234</InvoiceNumber> -->
      <!-- <InvoiceId>98765</InvoiceId> -->
      <!-- <PackageId>4321</PackageId> -->
    </ns1:pixiGetInvoicePackage>
  </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:pixiGetInvoicePackage>
      <!-- <InvoiceNumber>RE2024-001234</InvoiceNumber> -->
      <!-- <InvoiceId>98765</InvoiceId> -->
      <!-- <PackageId>4321</PackageId> -->
    </ns1:pixiGetInvoicePackage>
  </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 = [
    // 'InvoiceNumber' => 'RE2024-001234',
    // 'InvoiceId' => '98765',
    // 'PackageId' => '4321',
];

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

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

Verwendete Tabellen

SQL-Objekt:

dbo.pipiGetInvoicePackage

Prozedur zuletzt geändert am 2026-10-05

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