pixiReport_LogisticQuality_Details
pixi* Seal - get logistic quality
Since pixi version: LOU Official (6.3.0.4452) Additional notes:
Request
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) |
| CalcSeal | boolean | false | Used for pixi* Seal app, Dashboard app where we calculate Seal (versandsiegel) percentage Type: bit Default value: 0 Example: 1 Available from: LOU Official - Update 46 (6.9.46.27927) |
| 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) |
| ExcludeZeros | boolean | false | Used for filter parameter in pixi* Report client Type: bit Default value: 0 Example: 1 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_Details>
<DaysBack>0</DaysBack>
<ShopID>string</ShopID>
<ExcludeZeros>true</ExcludeZeros>
<OnlyItemsOnStock>true</OnlyItemsOnStock>
<CalcSeal>true</CalcSeal>
</pixiReport_LogisticQuality_Details>
</Body>
</Envelope>Response
1. Result set when parameter CalcSeal = 0
| Name | Type | Description |
|---|---|---|
| OrderNr | integer | pixi* order number of the shipped package Type: int Available from: 25.06 (25.6.0.58802) |
| Shipdate | string | Date of shipping in pixi* Type: datetime Available from: 25.06 (25.6.0.58802) |
| CreateDate | string | Date of order creation in pixi* Type: datetime Available from: 25.06 (25.6.0.58802) |
| DaysToShip | integer | Number of days needed to ship the package Type: int Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiReport_LogisticQuality_DetailsPost200TextXmlResponse>
<DaysToShip>0</DaysToShip>
<OrderNr>0</OrderNr>
<CreateDate>string</CreateDate>
<Shipdate>string</Shipdate>
</PixiReport_LogisticQuality_DetailsPost200TextXmlResponse>2. Result set when parameter CalcSeal = 1
| Name | Type | Description |
|---|---|---|
| DaysToShip | integer | Number of days needed to ship the packages Type: int Available from: 25.06 (25.6.0.58802) |
| NRofORders | integer | Total number of shipped orders Type: int Available from: 25.06 (25.6.0.58802) |
| Percentage | string | Calculated percentage of shipped orders Type: float Available from: 25.06 (25.6.0.58802) |
| par_ShopId | string | @ShopId input parameter value or -alle- for all shops Type: varchar Available from: 25.06 (25.6.0.58802) |
| AllPackages | string | Total number of all orders used in calculation Type: float Available from: 25.06 (25.6.0.58802) |
| par_DaysBack | integer | @DaysBack input parameter value Type: int Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiReport_LogisticQuality_DetailsPost200TextXmlResponse>
<DaysToShip>0</DaysToShip>
<OrderNr>0</OrderNr>
<CreateDate>string</CreateDate>
<Shipdate>string</Shipdate>
</PixiReport_LogisticQuality_DetailsPost200TextXmlResponse>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_Details>
<ShopID xsi:type="xsd:string">ABC</ShopID>
<CalcSeal xsi:type="xsd:boolean">1</CalcSeal>
<DaysBack xsi:type="xsd:integer">25</DaysBack>
<ExcludeZeros xsi:type="xsd:boolean">1</ExcludeZeros>
<OnlyItemsOnStock xsi:type="xsd:boolean">0</OnlyItemsOnStock>
</ns1:pixiReport_LogisticQuality_Details>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>PHP Example
<?php
getPixiSoapClientResponse('pixiReport_LogisticQuality_Details', [
'ShopID' => 'ABC', // string
'CalcSeal' => '1', // boolean
'DaysBack' => '25', // integer
'ExcludeZeros' => '1', // boolean
'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);
}