pixiReportShipOutPerTimeQuant

API call: report number of shipouts per given time period in certain time range.

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

General

Request

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

Request body

Name	Type	Required	Description
shopID	string	false	Id of the shop to get report for Type: varchar(3) Default value: Example: ADV Available from: LOU Official (6.3.0.4452)
timePeriod	string	false	Time interval between the data of report list Type: float Default value: 2 Example: 1 Available from: LOU Official (6.3.0.4452)
endDateTime	string	false	Date and time of report end Type: datetime Default value: NULL Example: 2021-11-11 20:23:44 Available from: LOU Official (6.3.0.4452)
startDateTime	string	false	Date and time of report start Type: datetime Default value: NULL Example: 2021-11-11 13:23:44 Available from: LOU Official (6.3.0.4452)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiReportShipOutPerTimeQuant>
      <startDateTime>string</startDateTime>
      <endDateTime>string</endDateTime>
      <timePeriod>string</timePeriod>
      <shopID>string</shopID>
    </pixiReportShipOutPerTimeQuant>
  </Body>
</Envelope>

Response

1. Result set

Name	Type	Description
shopID	string	Id of the shop that report is for Type: VARCHAR Available from: 25.06 (25.6.0.58802)
SUMShipOut	integer	Calculated SUM of shipped orders Type: int Available from: 25.06 (25.6.0.58802)
endTimePeriod	string	Date and time of report row end Type: VARCHAR Available from: 25.06 (25.6.0.58802)
startTimePeriod	string	Date and time of report row start Type: VARCHAR Available from: 25.06 (25.6.0.58802)

Response Example

<PixiReportShipOutPerTimeQuantPost200TextXmlResponse>
  <shopID>string</shopID>
  <SUMShipOut>0</SUMShipOut>
  <startTimePeriod>string</startTimePeriod>
  <endTimePeriod>string</endTimePeriod>
</PixiReportShipOutPerTimeQuantPost200TextXmlResponse>

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:pixiReportShipOutPerTimeQuant>
            <shopID xsi:type="xsd:string">ADV</shopID>
            <timePeriod xsi:type="xsd:string">1</timePeriod>
            <endDateTime xsi:type="xsd:string">2021-11-11 20:23:44</endDateTime>
            <startDateTime xsi:type="xsd:string">2021-11-11 13:23:44</startDateTime>
        </ns1:pixiReportShipOutPerTimeQuant>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiReportShipOutPerTimeQuant', [
    'shopID' => 'ADV', // string
    'timePeriod' => '1', // string
    'endDateTime' => '2021-11-11 20:23:44', // string
    'startDateTime' => '2021-11-11 13:23:44', // 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);
}

Unofficial Pixi-API-Documentation

by koempf24.de