Unofficial Pixi-API-Documentation

by koempf24.de

pixiReportShippedOrders

Pixi-Docs
Old Pixi-Docs

Enabled but undocumented

Returns All orders shipped out today (0:00) until now or for a given date span

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

    ShipoutOnGivenDay return orders shipped out today or on given (end) day.
    With parameter @StartDate we set start time and with parameter @EndDate we set day end time till we calculate data.
    
    Example: 
    EXEC dbo.pipiReportShippedOrders @StartDate = '2021-12-03 10:00:00.000', @EndDate = '2021-12-03 15:00:00.000'
    - we get data for 2021-12-03 between 10:00 and 15:00
    
    EXEC dbo.pipiReportShippedOrders @StartDate = '2021-12-03 00:00:00.000', @EndDate = '2021-12-03 00:00:00.000'
    - we get data for 2021-12-03 between 00:00 and 00:00, probably will get 0, unless we have ship out at 00:00:000 time.
    
    EXEC dbo.pipiReportShippedOrders @StartDate = '2021-12-01 00:00:00.000', @EndDate = '2021-12-03 15:00:00.000'
    - we get data for 2021-12-03 between 00:00 and 15:00
KPIs Reports Statistics

Request

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

Request body

Name Type Required Description
ShopID string false

Filter by shop

Type: varchar(3)

Default value:

Example: abcdefg

Available from: LOU Official (6.3.0.4452)
EndDate string false

End for shipped out orders

Type: datetime

Default value:

Example: YYYY-MM-DD hh:mm:ss

Available from: LOU Official (6.3.0.4452)
StartDate string false

Start for shipped out orders

Type: datetime

Default value:

Example: YYYY-MM-DD hh:mm:ss

Available from: LOU Official (6.3.0.4452)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiReportShippedOrders>
      <StartDate>string</StartDate>
      <EndDate>string</EndDate>
      <ShopID>string</ShopID>
    </pixiReportShippedOrders>
  </Body>
</Envelope>

Response

1. Shipped out values

Name Type Description
ShipoutOnGivenDay string

Orders shipped out today or on given (end) day, See Additional Notes

Type: varchar (10)

Available from: 25.06 (25.6.0.58802)
ShipoutInGivenMonth string

Orders shipped out in whole month, from 1st until given date (from @EndDate)

Type: varchar (10)

Available from: 25.06 (25.6.0.58802)
ShipoutOnPreviousDay string

Orders shipped out the day before (from @EndDate)

Type: varchar (10)

Available from: 25.06 (25.6.0.58802)
ShipoutInPreviousMonth string

Orders shipped out in previous month (from @EndDate)

Type: varchar (10)

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiReportShippedOrdersPost200TextXmlResponse>
  <ShipoutOnGivenDay>string</ShipoutOnGivenDay>
  <ShipoutOnPreviousDay>string</ShipoutOnPreviousDay>
  <ShipoutInGivenMonth>string</ShipoutInGivenMonth>
  <ShipoutInPreviousMonth>string</ShipoutInPreviousMonth>
</PixiReportShippedOrdersPost200TextXmlResponse>

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:pixiReportShippedOrders>
            <ShopID xsi:type="xsd:string">abcdefg</ShopID>
            <EndDate xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</EndDate>
            <StartDate xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</StartDate>
        </ns1:pixiReportShippedOrders>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiReportShippedOrders', [
    'ShopID' => 'abcdefg', // string
    'EndDate' => 'YYYY-MM-DD hh:mm:ss', // string
    'StartDate' => 'YYYY-MM-DD hh:mm:ss', // 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);
}