Unofficial Pixi-API-Documentation

by koempf24.de

pixiReport_StockValue_Hist

Pixi-Docs
Old Pixi-Docs

API call exposes Stock value hist report.

Since pixi version: AVA 17.03 (8.4.27.29272) Additional notes:

KPIs Reports Statistics

Request

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

Request body

Name Type Required Description
LocID string false

[optional] pixi* Location ID (filter).

Type: varchar(10)

Default value:

Example:

Available from: AVA 17.03 (8.4.27.29272)
SupplNr string false

[optional] pixi* Supplier number (filter).

Type: varchar(10)

Default value:

Example:

Available from: AVA 17.03 (8.4.27.29272)
Category string false

[optional] pixi* category ID (filter).

Type: varchar(10)

Default value:

Example:

Available from: AVA 17.03 (8.4.27.29272)
ParamDate string false

[optional] Date used to show the data of Stock value hist report. If left empty it defaults to end of current day.

Type: datetime

Default value:

Example:

Available from: AVA 17.03 (8.4.27.29272)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiReport_StockValue_Hist>
      <ParamDate>string</ParamDate>
      <LocID>string</LocID>
      <Category>string</Category>
      <SupplNr>string</SupplNr>
    </pixiReport_StockValue_Hist>
  </Body>
</Envelope>

Response

Name Type Description

Response Example

<PixiReport_StockValue_HistPost200TextXmlResponse />

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:pixiReport_StockValue_Hist>
            <LocID xsi:type="xsd:string"></LocID>
            <SupplNr xsi:type="xsd:string"></SupplNr>
            <Category xsi:type="xsd:string"></Category>
            <ParamDate xsi:type="xsd:string"></ParamDate>
        </ns1:pixiReport_StockValue_Hist>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiReport_StockValue_Hist', [
    'LocID' => '', // string
    'SupplNr' => '', // string
    'Category' => '', // string
    'ParamDate' => '', // 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);
}