KPIs Lesen

pixiReportShippedOrders

Liefert Dashboard-Zählwerte versendeter Rechnungen für den Stichtag, den Vortag, den laufenden Monat bis zum Enddatum und den Vormonat.

Zählt Versendungen für ein Dashboard. Eine Versendung ist ein Datensatz in Invoices mit einem ScanOutDate. Gezählt werden nur Rechnungen mit mindestens einer Auftragsposition (Orderlines.InvRef). Jede Rechnung zählt einmal; die Werte sind also Rechnungsanzahlen, keine Auftragsanzahlen.

Wirkung der Parameter:

EndDate ist standardmäßig das aktuelle Datum mit Uhrzeit (GETDATE()). Es ist der Bezugszeitpunkt für alle Zeiträume.
StartDate ist standardmäßig der erste Tag des Vormonats von EndDate. Es wird nur für den Wert des Stichtags verwendet, und nur wenn es auf demselben Kalendertag wie EndDate liegt. Ist StartDate später als EndDate, wird es auf EndDate gesetzt.
ShopID beschränkt die Zählung auf Rechnungen mit mindestens einer Auftragsposition mit OrdShopID = ShopID. Ein leerer Wert oder NULL bedeutet alle Shops.

Zuerst werden alle passenden Rechnungen gesammelt, deren ScanOutDate zwischen dem Beginn des Vormonats und dem Ende des Tages von EndDate liegt. Danach wird eine Zeile mit vier Zählwerten geliefert (alle Bereiche schließen beide Grenzen ein):

ShipoutOnGivenDay: ab StartDate (am selben Tag) oder sonst ab Mitternacht des Tages von EndDate, bis EndDate.
ShipoutOnPreviousDay: der ganze Kalendertag vor EndDate.
ShipoutInGivenMonth: vom 1. des Monats von EndDate, 00:00 Uhr, bis EndDate.
ShipoutInPreviousMonth: der ganze vorherige Kalendermonat.

Hinweise

Alle vier Zählwerte werden in varchar(10)-Variablen gespeichert und daher als Zeichenketten geliefert, nicht als Ganzzahlen.
Die Zählung reicht bis EndDate selbst, nicht bis zum Ende dieses Tages. Wird EndDate ohne Uhrzeit (Mitternacht) übergeben, zählt ShipoutOnGivenDay nur Rechnungen, die genau um Mitternacht gescannt wurden, und ShipoutInGivenMonth lässt den ganzen Tag von EndDate aus. Daher eine Uhrzeit wie 23:59:59 übergeben oder EndDate weglassen, damit die aktuelle Uhrzeit gilt.
Mit StartDate lässt sich kein Zeitraum über mehrere Tage abfragen. Liegt es auf einem anderen Tag als EndDate, wird es ignoriert, und die Zählung für den Stichtag beginnt um Mitternacht des Tages von EndDate.
Die Lesezugriffe verwenden NOLOCK; die Zählwerte können daher nicht festgeschriebene Daten enthalten.
Tritt ein Fehler auf, wird die Meldung nur per PRINT ausgegeben, und die Prozedur endet mit Rückgabewert -1 ohne Ergebnismenge.

Parameter

Parameter	Typ	Standardwert	Beschreibung
`StartDate`	datetime dateTime	NULL	Startzeitpunkt für die Zählung am Stichtag. Wird nur verwendet, wenn er auf demselben Kalendertag wie `EndDate` liegt. Standard: erster Tag des Vormonats von `EndDate`; die Zählung beginnt dann um Mitternacht des Tages von `EndDate`. Beispiel: `2024-05-15T08:00:00`
`EndDate`	datetime dateTime	NULL	Bezugszeitpunkt. Alle Zeiträume werden davon abgeleitet; die Zählwerte für Stichtag und Monat reichen bis zu diesem Zeitpunkt. Standard: aktuelles Datum mit Uhrzeit. Beispiel: `2024-05-15T17:30:00`
`ShopID`	varchar(3) string	–	Shop-Filter. Gezählt werden nur Rechnungen mit mindestens einer Auftragsposition dieses Shops (`OrdShopID`). Leer oder `NULL` bedeutet alle Shops. Beispiel: `SHP`

Antwort

Result-Set 1 · Bei Erfolg (entfällt, wenn im TRY-Block ein Fehler auftritt)

Eine Zeile mit den vier Versand-Zählwerten.

Spalte	Typ	Beschreibung
`ShipoutOnGivenDay`	varchar(10) string	Anzahl der Rechnungen mit `ScanOutDate` ab `StartDate` (am selben Tag) oder ab Mitternacht des Tages von `EndDate` bis `EndDate`.
`ShipoutOnPreviousDay` Kann leer sein	varchar(10) string	Anzahl der Rechnungen mit Scan-Out am ganzen Kalendertag vor `EndDate`.
`ShipoutInGivenMonth` Kann leer sein	varchar(10) string	Anzahl der Rechnungen mit Scan-Out vom 1. des Monats von `EndDate` bis `EndDate`.
`ShipoutInPreviousMonth` Kann leer sein	varchar(10) string	Anzahl der Rechnungen mit Scan-Out im ganzen vorherigen Kalendermonat.

Beispielantwort

<SqlRowSet1>
  <row>
    <ShipoutOnGivenDay>142</ShipoutOnGivenDay>
    <ShipoutOnPreviousDay>318</ShipoutOnPreviousDay>
    <ShipoutInGivenMonth>4127</ShipoutInGivenMonth>
    <ShipoutInPreviousMonth>8954</ShipoutInPreviousMonth>
  </row>
</SqlRowSet1>

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:pixiReportShippedOrders>
      <!-- <StartDate>2024-05-15T08:00:00</StartDate> -->
      <!-- <EndDate>2024-05-15T17:30:00</EndDate> -->
      <!-- <ShopID>SHP</ShopID> -->
    </ns1:pixiReportShippedOrders>
  </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:pixiReportShippedOrders>
      <!-- <StartDate>2024-05-15T08:00:00</StartDate> -->
      <!-- <EndDate>2024-05-15T17:30:00</EndDate> -->
      <!-- <ShopID>SHP</ShopID> -->
    </ns1:pixiReportShippedOrders>
  </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 = [
    // 'StartDate' => '2024-05-15T08:00:00',
    // 'EndDate' => '2024-05-15T17:30:00',
    // 'ShopID' => 'SHP',
];

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

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

Verwendete Tabellen

Invoices · Lesen Orderlines · Lesen

SQL-Objekt:: dbo.pipiReportShippedOrders