Unofficial Pixi-API-Documentation

by koempf24.de

pixiReportReceivedOrders

Pixi-Docs
Old Pixi-Docs

Get number of all received orders for time period, if @PerLocation=1 number of received per location will be returned.

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

KPIs Reports Statistics

Request

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

Request body

Name Type Required Description
ShopID string false

Filter: Shop.

Type: varchar(3)

Default value:

Example: abc

Available from: LOU Official (6.3.0.4452)
FromTime string true

Filter: Start of invoice date range.

Type: datetime

Default value:

Example: 2017-01-01 00:00:00

Available from: LOU Official (6.3.0.4452)
UntilTime string true

Filter: End of invoice date range.

Type: datetime

Default value:

Example: 2017-12-31 23:59:96

Available from: LOU Official (6.3.0.4452)
PerLocation boolean false

@PerLocation = 0 or empty - all locations summarized | = 1 - each location individually.

Type: bit

Default value: 0

Example: 0 or 1

Available from: 21.01 (9.0.23.54983)
ReceivedOrders integer false

Return summary of received orders.

Type: int

Default value: NULL

Example: NULL

Available from: LOU Official (6.3.0.4452)
MinutesSinceRefresh integer false

Parameter @MinutesSinceRefresh does not change the results

Type: int

Default value: NULL

Example: NULL

Available from: LOU Official (6.3.0.4452)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiReportReceivedOrders>
      <FromTime>string</FromTime>
      <UntilTime>string</UntilTime>
      <ShopID>string</ShopID>
      <ReceivedOrders>0</ReceivedOrders>
      <MinutesSinceRefresh>0</MinutesSinceRefresh>
      <PerLocation>true</PerLocation>
    </pixiReportReceivedOrders>
  </Body>
</Envelope>

Response

1. Received orders.

Name Type Description
ReceivedOrders integer

Number of received orders.

Type: INT

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiReportReceivedOrdersPost200TextXmlResponse>
  <ReceivedOrders>0</ReceivedOrders>
</PixiReportReceivedOrdersPost200TextXmlResponse>

2. Received orders.

Name Type Description
LocationID string

Location of received orders.

Type: varchar(3)

Available from: 25.06 (25.6.0.58802)
ReceivedOrders integer

Number of received orders.

Type: INT

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiReportReceivedOrdersPost200TextXmlResponse>
  <ReceivedOrders>0</ReceivedOrders>
</PixiReportReceivedOrdersPost200TextXmlResponse>

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:pixiReportReceivedOrders>
            <ShopID xsi:type="xsd:string">abc</ShopID>
            <FromTime xsi:type="xsd:string">2017-01-01 00:00:00</FromTime> <!-- required -->
            <UntilTime xsi:type="xsd:string">2017-12-31 23:59:96</UntilTime> <!-- required -->
            <PerLocation xsi:type="xsd:boolean">0 or 1</PerLocation>
            <ReceivedOrders xsi:type="xsd:integer">NULL</ReceivedOrders>
            <MinutesSinceRefresh xsi:type="xsd:integer">NULL</MinutesSinceRefresh>
        </ns1:pixiReportReceivedOrders>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiReportReceivedOrders', [
    'ShopID' => 'abc', // string
    'FromTime' => '2017-01-01 00:00:00', // string (required)
    'UntilTime' => '2017-12-31 23:59:96', // string (required)
    'PerLocation' => '0 or 1', // boolean
    'ReceivedOrders' => 'NULL', // integer
    'MinutesSinceRefresh' => 'NULL', // integer
]);

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