Unofficial Pixi-API-Documentation

by koempf24.de

pixiFederalStatisticReport

Pixi-Docs
Old Pixi-Docs

The call returns Federal Statistic Report of delivered items grouped by supplier country

Since pixi version: AVA Official - Update 23 (8.4.23.27873) Additional notes:

KPIs Reports Statistics

Request

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

Request body

Name Type Required Description
DateTo string false

End date of required time span. (Default: Last day of previous month).

Type: datetime

Default value: NULL

Example:

Available from: AVA Official - Update 23 (8.4.23.27873)
SupplNR string false

Filter by Supplier number code.

Type: varchar(4)

Default value: NULL

Example:

Available from: AVA Official - Update 23 (8.4.23.27873)
DateFrom string false

Start date of required time span. (Default: First day of previous month).

Type: datetime

Default value: NULL

Example:

Available from: AVA Official - Update 23 (8.4.23.27873)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiFederalStatisticReport>
      <DateFrom>string</DateFrom>
      <DateTo>string</DateTo>
      <SupplNR>string</SupplNR>
    </pixiFederalStatisticReport>
  </Body>
</Envelope>

Response

1. Result set

Name Type Description
Year integer

Year in which the item was delivered

Type: int

Available from: 25.06 (25.6.0.58802)
Month integer

Month in which the item was delivered

Type: int

Available from: 25.06 (25.6.0.58802)
HomePageUrl string

Information if the supplier needs to be considered in the FSO report

Type: varchar

Available from: 25.06 (25.6.0.58802)
DeliveredQty integer

Delivered qty of this item from the concerning supplier for the whole month

Type: int

Available from: 25.06 (25.6.0.58802)
DeliveredAmount integer

Supplier price of the item from delivery document, multiplied by delivered qty

Type: int

Available from: 25.06 (25.6.0.58802)
DeliveredWeight integer

Weight of the item (summarized for delivered qty of that item, i.e. delivered qty * weight)

Type: int

Available from: 25.06 (25.6.0.58802)
SupplierCountry string

Country of supplier (ISO-2 format)

Type: varchar

Available from: 25.06 (25.6.0.58802)
CustomsTariffText string

Customs Tariff Text imported for the item with item import

Type: varchar

Available from: 25.06 (25.6.0.58802)
CustomsTariffNumber string

Customs Tariff Number imported for the item with item import

Type: varchar

Available from: 25.06 (25.6.0.58802)
CustomsCountryOfOrigin string

Country of Origin imported for the item with item import (ISO-2 format)

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiFederalStatisticReportPost200TextXmlResponse>
  <Year>0</Year>
  <Month>0</Month>
  <SupplierCountry>string</SupplierCountry>
  <CustomsCountryOfOrigin>string</CustomsCountryOfOrigin>
  <CustomsTariffNumber>string</CustomsTariffNumber>
  <CustomsTariffText>string</CustomsTariffText>
  <DeliveredWeight>0</DeliveredWeight>
  <DeliveredQty>0</DeliveredQty>
  <DeliveredAmount>0</DeliveredAmount>
  <HomePageUrl>string</HomePageUrl>
</PixiFederalStatisticReportPost200TextXmlResponse>

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:pixiFederalStatisticReport>
            <DateTo xsi:type="xsd:string"></DateTo>
            <SupplNR xsi:type="xsd:string"></SupplNR>
            <DateFrom xsi:type="xsd:string"></DateFrom>
        </ns1:pixiFederalStatisticReport>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiFederalStatisticReport', [
    'DateTo' => '', // string
    'SupplNR' => '', // string
    'DateFrom' => '', // 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);
}