pixiReportShippedOrders · Pixi API documentation

Counts shipments for a dashboard. A shipment is a record in Invoices with a ScanOutDate. Only invoices with at least one order line (Orderlines.InvRef) are counted. Each invoice counts once, so the values are invoice counts, not order counts.

How the parameters work:

EndDate defaults to the current date and time (GETDATE()). It is the reference date for all periods.
StartDate defaults to the first day of the month before EndDate. It is only used for the given-day value, and only if it is on the same calendar day as EndDate. If StartDate is later than EndDate, it is set to EndDate.
ShopID limits the count to invoices that have at least one order line with OrdShopID = ShopID. An empty value or NULL means all shops.

The call first collects all matching invoices whose ScanOutDate lies between the start of the previous month and the end of the EndDate day. It then returns one row with four counts (all ranges include both ends):

ShipoutOnGivenDay: from StartDate (same day) or else midnight of the EndDate day, up to EndDate.
ShipoutOnPreviousDay: the whole calendar day before EndDate.
ShipoutInGivenMonth: from the 1st of the EndDate month, 00:00, up to EndDate.
ShipoutInPreviousMonth: the whole previous calendar month.

Notes

All four counts are uppercase-free strings in SQL terms: they are stored in varchar(10) variables, so they come back as strings, not integers.
The counts run up to EndDate itself, not to the end of that day. If EndDate is passed without a time (midnight), ShipoutOnGivenDay only counts invoices scanned exactly at midnight, and ShipoutInGivenMonth leaves out the whole EndDate day. Pass a time such as 23:59:59, or omit EndDate to use the current time.
StartDate cannot be used for a range over several days. If it is on another day than EndDate, it is ignored and the given-day count starts at midnight of the EndDate day.
Reads use NOLOCK, so the counts can include uncommitted data.
If an error occurs, the message is only printed and the procedure returns -1 without any result set.

Tables used

Invoices · Read Orderlines · Read

Parameter	Type	Default	Description
`StartDate`	datetime dateTime	NULL	Start time for the given-day count. Only used if it is on the same calendar day as `EndDate`. Default: first day of the month before `EndDate`, which means the count starts at midnight of the `EndDate` day. Example: `2024-05-15T08:00:00`
`EndDate`	datetime dateTime	NULL	Reference date and time. All periods are calculated from it, and the given-day and given-month counts run up to this moment. Default: current date and time. Example: `2024-05-15T17:30:00`
`ShopID`	varchar(3) string	–	Shop filter. Only invoices with at least one order line of this shop (`OrdShopID`) are counted. Empty or `NULL` means all shops. Example: `SHP`

Result set 1 · On success (not returned if an error occurs inside the TRY block)

One row with the four shipment counts.

Column	Type	Description
`ShipoutOnGivenDay`	varchar(10) string	Number of invoices with `ScanOutDate` from `StartDate` (same day) or midnight of the `EndDate` day up to `EndDate`.
`ShipoutOnPreviousDay` Nullable	varchar(10) string	Number of invoices scanned out on the whole calendar day before `EndDate`.
`ShipoutInGivenMonth` Nullable	varchar(10) string	Number of invoices scanned out from the 1st of the `EndDate` month up to `EndDate`.
`ShipoutInPreviousMonth` Nullable	varchar(10) string	Number of invoices scanned out in the whole previous calendar month.

Response example

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

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);