Unofficial Pixi-API-Documentation

by koempf24.de

pixiReportShippingEfficiency

Pixi-Docs
Old Pixi-Docs

Enabled but undocumented

Report function, made for CEO Dashboard project .

Since pixi version: LOU Official (6.3.0.4452) Additional notes:

KPIs Reports Statistics

Request

POST https://apigateway.descartes.com/tms/pixi/pixiReportShippingEfficiency

Request body

Name Type Required Description
SamplingPeriod integer false

Defines how many days we search for shipped orders.

Type: int

Default value: 7

Example: 123

Available from: LOU Official (6.3.0.4452)
AVGThroughputTimeInDays string false

output parameter

Type: float

Default value: NULL

Example:

Available from: LOU Official (6.3.0.4452)
PercThroughputTimeIn24h string false

output parameter

Type: float

Default value: NULL

Example:

Available from: LOU Official (6.3.0.4452)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiReportShippingEfficiency>
      <SamplingPeriod>0</SamplingPeriod>
      <AVGThroughputTimeInDays>string</AVGThroughputTimeInDays>
      <PercThroughputTimeIn24h>string</PercThroughputTimeIn24h>
    </pixiReportShippingEfficiency>
  </Body>
</Envelope>

Response

1. Return status

Name Type Description
AVGThroughputTimeInDays string

AVGThroughputTimeInDays

Type: float

Available from: 25.06 (25.6.0.58802)
PercThroughputTimeIn24h string

PercThroughputTimeIn24h

Type: float

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiReportShippingEfficiencyPost200TextXmlResponse>
  <AVGThroughputTimeInDays>string</AVGThroughputTimeInDays>
  <PercThroughputTimeIn24h>string</PercThroughputTimeIn24h>
</PixiReportShippingEfficiencyPost200TextXmlResponse>

HTTP Example

POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
# echo -n '{{username}}:{{password}}' | base64 | pbcopy
Authorization: Basic {{token}}

<?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/"
                   xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                   SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
    <SOAP-ENV:Body>
        <ns1:pixiReportShippingEfficiency>
            <SamplingPeriod xsi:type="xsd:integer">123</SamplingPeriod>
            <AVGThroughputTimeInDays xsi:type="xsd:string"></AVGThroughputTimeInDays>
            <PercThroughputTimeIn24h xsi:type="xsd:string"></PercThroughputTimeIn24h>
        </ns1:pixiReportShippingEfficiency>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiReportShippingEfficiency', [
    'SamplingPeriod' => '123', // integer
    'AVGThroughputTimeInDays' => '', // string
    'PercThroughputTimeIn24h' => '', // string
]);

function getPixiSoapClientResponse(string $method, array $arguments = [])
{
    $soapArguments = [];
    foreach ($arguments as $key => $value) {
        $soapArguments[] = new SoapVar($value, null, '', '', $key);
    }

    $soapClient = new SoapClient(null, [
        'login' => '...',
        'password' => '...',
        'uri' => 'https://apigateway.descartes.com/tms/pixi/',
        'location' => 'https://apigateway.descartes.com/tms/pixi/',
    ]);

    return $soapClient->__call($method, $soapArguments);
}