pixiReportGetUnshippableOrders
It shows orders which cannot be shipped yet
Since pixi version: LOU Official (6.3.0.4452) Additional notes:
Request
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| LocID | string | false | Special stock locations are not considered. The location parameter is not connected to the actual order location. It just shows you the available stock on given location. Type: varchar(3) Default value: NULL Example: abcdefg Available from: LOU Official - Update 46 (6.9.46.27927) |
| ViewDetails | boolean | false | Extended resultset Type: bit Default value: NULL Example: 0 or 1 Available from: LOU Official (6.3.0.4452) |
| IncludeCustLock | boolean | false | Show also results with active customer lock. Type: bit Default value: NULL Example: 0 or 1 Available from: LOU Official - Update 46 (6.9.46.27927) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiReportGetUnshippableOrders>
<ViewDetails>true</ViewDetails>
<IncludeCustLock>true</IncludeCustLock>
<LocID>string</LocID>
</pixiReportGetUnshippableOrders>
</Body>
</Envelope>Response
| Name | Type | Description |
|---|---|---|
| Orders | integer | Type: int Available from: 25.06 (25.6.0.58802) |
| ShipCost | number | The total shipping costs of the whole order Type: money Available from: 25.06 (25.6.0.58802) |
| OrderTotal | number | Type: money Available from: 25.06 (25.6.0.58802) |
| dbCurrency | string | Type: varchar (3) Available from: 25.06 (25.6.0.58802) |
| MissingArticles | integer | Type: int Available from: 25.06 (25.6.0.58802) |
| DiffrentArticles | integer | Type: int Available from: 25.06 (25.6.0.58802) |
| DiffrentCustomers | integer | Type: int Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiReportGetUnshippableOrdersPost200TextXmlResponse>
<Orders>0</Orders>
<OrderTotal>0</OrderTotal>
<ShipCost>0</ShipCost>
<DiffrentCustomers>0</DiffrentCustomers>
<MissingArticles>0</MissingArticles>
<DiffrentArticles>0</DiffrentArticles>
<dbCurrency>string</dbCurrency>
</PixiReportGetUnshippableOrdersPost200TextXmlResponse>| Name | Type | Description |
|---|---|---|
| Qty | integer | Ordered item quantity Type: int Available from: 25.06 (25.6.0.58802) |
| Price | number | Final gross price (not depending on the order type) Type: money Available from: 25.06 (25.6.0.58802) |
| Status | string | Type: varchar (3) Available from: 25.06 (25.6.0.58802) |
| CustRef | integer | ID of customer Type: int Available from: 25.06 (25.6.0.58802) |
| ItemRef | integer | Item ID Type: int Available from: 25.06 (25.6.0.58802) |
| OrderNr | integer | Order number in pixi* Type: int Available from: 25.06 (25.6.0.58802) |
| SLocked | string | If order has ship lock enabled Type: varchar (1) Available from: 25.06 (25.6.0.58802) |
| ShipCost | number | The total shipping costs of the whole order Type: money Available from: 25.06 (25.6.0.58802) |
| ItemNrInt | string | Shop item number Type: varchar (50) Available from: 25.06 (25.6.0.58802) |
| OrderDate | string | Create date of the order Type: datetime Available from: 25.06 (25.6.0.58802) |
| Shippable | integer | Type: int Available from: 25.06 (25.6.0.58802) |
| dbCurrency | string | Database currency Type: varchar (3) Available from: 25.06 (25.6.0.58802) |
| OrderlineKey | integer | ID for the Orderline record Type: int Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiReportGetUnshippableOrdersPost200TextXmlResponse>
<Orders>0</Orders>
<OrderTotal>0</OrderTotal>
<ShipCost>0</ShipCost>
<DiffrentCustomers>0</DiffrentCustomers>
<MissingArticles>0</MissingArticles>
<DiffrentArticles>0</DiffrentArticles>
<dbCurrency>string</dbCurrency>
</PixiReportGetUnshippableOrdersPost200TextXmlResponse>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:pixiReportGetUnshippableOrders>
<LocID xsi:type="xsd:string">abcdefg</LocID>
<ViewDetails xsi:type="xsd:boolean">0 or 1</ViewDetails>
<IncludeCustLock xsi:type="xsd:boolean">0 or 1</IncludeCustLock>
</ns1:pixiReportGetUnshippableOrders>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>PHP Example
<?php
getPixiSoapClientResponse('pixiReportGetUnshippableOrders', [
'LocID' => 'abcdefg', // string
'ViewDetails' => '0 or 1', // boolean
'IncludeCustLock' => '0 or 1', // 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);
}