pixiGetPartialDeliveryStatus
API Call returns Delivery Status for an order
Since pixi version: LOU Official (6.3.0.4452) Additional notes:
Request
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| OrderNr | integer | true | Order number Type: int Default value: Example: 123456 Available from: LOU Official (6.3.0.4452) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiGetPartialDeliveryStatus>
<OrderNr>0</OrderNr>
</pixiGetPartialDeliveryStatus>
</Body>
</Envelope>Response
1. Result set
| Name | Type | Description |
|---|---|---|
| OrderNr | integer | OrderNr value returned Type: int Available from: 25.06 (25.6.0.58802) |
| PartialDeliveryActive | boolean | A bit flag which is 1 (True) when the order is scheduled for partital delivery and 0 (False) when it isnt Type: bit Available from: 25.06 (25.6.0.58802) |
| CancelUnavailableItems | boolean | A bit flag which is 1 (True), if the order is scheduled for partital delivery, all remaining items would be cancelled after the partial shipment is complete Type: bit Available from: 25.06 (25.6.0.58802) |
| PartialDeliveryForRemaining | boolean | A bit flag which is 1 (True), if the order is scheduled for partital delivery and the remaining items are not being cancelled, they (the remaining items) would be also shipped upon their arrival in the stock Type: bit Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiGetPartialDeliveryStatusPost200TextXmlResponse>
<OrderNr>0</OrderNr>
<PartialDeliveryActive>true</PartialDeliveryActive>
<CancelUnavailableItems>true</CancelUnavailableItems>
<PartialDeliveryForRemaining>true</PartialDeliveryForRemaining>
</PixiGetPartialDeliveryStatusPost200TextXmlResponse>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:pixiGetPartialDeliveryStatus>
<OrderNr xsi:type="xsd:integer">123456</OrderNr> <!-- required -->
</ns1:pixiGetPartialDeliveryStatus>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>PHP Example
<?php
getPixiSoapClientResponse('pixiGetPartialDeliveryStatus', [
'OrderNr' => '123456', // integer (required)
]);
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);
}