pixiDFCreateInvoices

Legt Direct-Fulfillment-Rechnungen (DF) für bereite Auftragspositionen an, optional eingeschränkt auf und ergänzt um Versanddienstleister und Tracking-Daten aus XML.

Der Aufruf legt Rechnungen für Direct-Fulfillment-Aufträge an. Die eigentliche Verarbeitung übernimmt die interne Prozedur Pixi_CreateFulfillmentIncoices, die mit CreateEmp = 'API' läuft.

Ablauf

1. Ein exklusiver Application-Lock pipiDFCreateInvoices wird mit 5 Sekunden Timeout angefordert, damit parallele Läufe nacheinander ausgeführt werden.

2. Ist OrderlinesXML gesetzt (ein Leerstring gilt als NULL), werden die Elemente /Orderlines/Orderline mit den Unterelementen OrderlineKey, ShipVendor, ShipmentTrackingId und ReturnTrackingId gelesen.

3. Bei ShowDetailedMessages = 1 wird die Eingabe zuerst geprüft:

   • Das XML muss vorhanden sein und mindestens ein Orderline enthalten.
   • Der Versanddienstleister-Code (aus der ersten Zeile je Auftrag) darf höchstens 3 Zeichen lang sein.
   • Alle Sendungs-Tracking-IDs eines Auftrags, mit ; verbunden, dürfen höchstens 512 Zeichen lang sein. Dieselbe Grenze gilt für die Retouren-Tracking-IDs.
   • Jeder OrderlineKey muss in Orderlines existieren.

   Schlägt eine Prüfung fehl, werden alle Fehlerzeilen zurückgegeben und keine Rechnung angelegt.

4. Die Rechnungen werden angelegt. Das Verhalten hängt von den Einstellungen EnableFulfilmentTypeOne und EnableFulfilmentTypeTwo ab:

   • Typ eins: Auftragspositionen aus dem XML mit Status FUT werden zuerst auf FUS gesetzt. Danach wird je Auftrag mit FUS-Positionen eine Rechnung erzeugt. Mit XML werden nur die übergebenen Positionen verwendet, ohne XML alle FUS-Positionen.
   • Typ zwei: Kandidaten sind Aufträge, deren Positionen alle FUS oder in einem Endstatus sind und die mindestens eine FUS-Position ohne Rechnung haben. Das XML schränkt die Kandidaten-Aufträge nicht ein. Es bestimmt nur, welche FUS-Positionen in die Rechnung übernommen werden. Positionen mit Status MIN werden immer übernommen.

5. Jeder Auftrag wird in einer eigenen Transaktion verarbeitet:

   • Die Rechnung wird angelegt, mit Fulfillment = 1 gekennzeichnet und mit Rechnungspositionen versehen.
   • Der Versanddienstleister aus dem XML ersetzt den des Auftrags.
   • Tracking-IDs aus dem XML werden an der Rechnung gespeichert. Mehrere IDs können mit ; getrennt werden, und jede eindeutige ID wird ein eigenes Rechnungspaket.
   • Die Auftragspositionen werden auf AUS mit InvRef und ShipDate gesetzt.
   • Eine Rechnungsnummer wird vergeben, eine Buchung im Kundenkonto angelegt und die Rechnung ausgescannt.
   • Ein Event InvoiceCreated wird veröffentlicht.

6. Bei ShowDetailedMessages = 1 wird eine Statustabelle zurückgegeben:

   • eine OK-Zeile mit den Rechnungsnummern, die mit den übergebenen Positionen verknüpft sind;
   • eine ERROR-Zeile mit Aufträgen, deren übergebene Positionen keine Rechnungsposition haben;
   • eine ERROR-Zeile, wenn beides nicht zutrifft.

Bei ShowDetailedMessages = 0 wird keine Ergebnismenge geliefert.

Parameter

<Orderlines>
  <Orderline>
    <OrderlineKey>123456</OrderlineKey>
    <ShipVendor>DHL</ShipVendor>
    <ShipmentTrackingId>00340434161234567890</ShipmentTrackingId>
    <ReturnTrackingId>00340434169876543210</ReturnTrackingId>
  </Orderline>
  <Orderline>
    <OrderlineKey>123457</OrderlineKey>
    <ShipVendor>DHL</ShipVendor>
    <ShipmentTrackingId>00340434161234567891</ShipmentTrackingId>
    <ReturnTrackingId/>
  </Orderline>
</Orderlines>

Antwort

Result-Set 1 · Nur bei ShowDetailedMessages = 1 und fehlgeschlagener Prüfung. Wird statt des Verarbeitungsergebnisses geliefert; keine Rechnungen werden angelegt.

Eine Zeile je Prüfungsfehler.

Result-Set 2 · Bei ShowDetailedMessages = 1 und erfolgreicher Prüfung, nach der Rechnungserstellung.

Statuszeilen. Eine ERROR-Zeile nennt Aufträge ohne Rechnungspositionen, eine OK-Zeile die erzeugten bzw. verknüpften Rechnungsnummern. Beide können gemeinsam auftreten.

<SqlRowSet1>
  <row>
    <ReturnCode>OK</ReturnCode>
    <ErrorMessage>Direct fulfilment Invoice(s) created with invoice number(s): RE100234; RE100235</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:pixiDFCreateInvoices>
      <!-- <OrderlinesXML><![CDATA[<Orderlines><Orderline><OrderlineKey>123456</OrderlineKey><ShipVendor>DHL</ShipVendor><ShipmentTrackingId>00340434161234567890</ShipmentTrackingId><ReturnTrackingId>00340434169876543210</ReturnTrackingId></Orderline><Orderline><OrderlineKey>123457</OrderlineKey><ShipVendor>DHL</ShipVendor><ShipmentTrackingId>00340434161234567891</ShipmentTrackingId><ReturnTrackingId></ReturnTrackingId></Orderline></Orderlines>]]></OrderlinesXML> -->
      <!-- <ShowDetailedMessages>1</ShowDetailedMessages> -->
    </ns1:pixiDFCreateInvoices>
  </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:pixiDFCreateInvoices>
      <!-- <OrderlinesXML><![CDATA[<Orderlines><Orderline><OrderlineKey>123456</OrderlineKey><ShipVendor>DHL</ShipVendor><ShipmentTrackingId>00340434161234567890</ShipmentTrackingId><ReturnTrackingId>00340434169876543210</ReturnTrackingId></Orderline><Orderline><OrderlineKey>123457</OrderlineKey><ShipVendor>DHL</ShipVendor><ShipmentTrackingId>00340434161234567891</ShipmentTrackingId><ReturnTrackingId></ReturnTrackingId></Orderline></Orderlines>]]></OrderlinesXML> -->
      <!-- <ShowDetailedMessages>1</ShowDetailedMessages> -->
    </ns1:pixiDFCreateInvoices>
  </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 = [
    // 'OrderlinesXML' => '<Orderlines><Orderline><OrderlineKey>123456</OrderlineKey><ShipVendor>DHL</ShipVendor><ShipmentTrackingId>00340434161234567890</ShipmentTrackingId><ReturnTrackingId>00340434169876543210</ReturnTrackingId></Orderline><Orderline><OrderlineKey>123457</OrderlineKey><ShipVendor>DHL</ShipVendor><ShipmentTrackingId>00340434161234567891</ShipmentTrackingId><ReturnTrackingId></ReturnTrackingId></Orderline></Orderlines>',
    // 'ShowDetailedMessages' => '1',
];

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

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

Verwendete Tabellen

SQL-Objekt:

dbo.pipiDFCreateInvoices

Prozedur zuletzt geändert am 2026-10-05

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