Unofficial Pixi-API-Documentation

by koempf24.de

pixiReport_LogisticQuality_NonCached

Pixi-Docs
Old Pixi-Docs

Deprecated - use pixiReport_LogisticQuality_Details instead

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

General

Request

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

Request body

Name Type Required Description
ShopID string false

Calculate the logistic quality for specified shop

Type: varchar(3)

Default value: (empty)

Example: ABC

Available from: LOU Official (6.3.0.4452)
DaysBack integer false

Number of days back, that the report should take in consideration

Type: int

Default value: 14

Example: 25

Available from: LOU Official (6.3.0.4452)
OnlyItemsOnStock boolean false

Calculate the logistic quality only for orders where enough items were on stock

Type: bit

Default value: 1

Example: 0

Available from: LOU Official (6.3.0.4452)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiReport_LogisticQuality_NonCached>
      <DaysBack>0</DaysBack>
      <ShopID>string</ShopID>
      <OnlyItemsOnStock>true</OnlyItemsOnStock>
    </pixiReport_LogisticQuality_NonCached>
  </Body>
</Envelope>

Response

1. Result set

Name Type Description
DaysToShip integer

Number of days needed to ship the packages

Type: int

Available from: / (25.7.0.59144)
NRofORders integer

Total number of shipped orders

Type: int

Available from: / (25.7.0.59144)
Percentage string

Calculated percentage of shipped orders

Type: float

Available from: / (25.7.0.59144)
par_ShopId string

@ShopId input parameter value or -alle- for all shops

Type: varchar (3)

Available from: / (25.7.0.59144)
AllPackages string

Total number of all orders used in calculation

Type: float

Available from: / (25.7.0.59144)
par_DaysBack integer

@DaysBack input parameter value

Type: int

Available from: / (25.7.0.59144)

Response Example

<PixiReport_LogisticQuality_NonCachedPost200TextXmlResponse>
  <DaysToShip>0</DaysToShip>
  <NRofORders>0</NRofORders>
  <Percentage>string</Percentage>
  <AllPackages>string</AllPackages>
  <par_ShopId>string</par_ShopId>
  <par_DaysBack>0</par_DaysBack>
</PixiReport_LogisticQuality_NonCachedPost200TextXmlResponse>

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_LogisticQuality_NonCached>
            <ShopID xsi:type="xsd:string">ABC</ShopID>
            <DaysBack xsi:type="xsd:integer">25</DaysBack>
            <OnlyItemsOnStock xsi:type="xsd:boolean">0</OnlyItemsOnStock>
        </ns1:pixiReport_LogisticQuality_NonCached>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiReport_LogisticQuality_NonCached', [
    'ShopID' => 'ABC', // string
    'DaysBack' => '25', // integer
    'OnlyItemsOnStock' => '0', // boolean
]);

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