Orders Read

pixiGetPartialDeliveryStatus

Returns the partial delivery settings of an order: whether partial delivery is active, unavailable items are cancelled and the remainder is also shipped partially.

Reads the order header identified by OrderNr and returns its partial delivery flags.

PartialDeliveryActive comes from ForceToPicklistIfNotFULL. If that value is NULL, the call returns 0.
CancelUnavailableItems comes from OHCancelAfterForcedShipOut.
PartialDeliveryForRemaining comes from OHMultiForceToPicklist.

If no order with this number exists, the call returns an empty result set.

Notes

The table is read with NOLOCK, so uncommitted changes may be visible.
No error row is returned for an unknown order number; check whether the result set contains a row.

Tables used

OrderHeader · Read

Parameter	Type	Default	Description
`OrderNr` Required	int	–	Internal order number (`OrderHeader.OrderNr`) of the order to check. Example: `123456`

Result set 1 · Always; contains one row if the order exists, otherwise no rows.

Partial delivery settings of the order.

Column	Type	Description
`OrderNr`	int	Internal order number.
`PartialDeliveryActive`	bit boolean	1 if partial delivery is active, i.e. the order is forced to the picklist even if not all items are available (`ForceToPicklistIfNotFULL`). NULL is returned as 0.
`CancelUnavailableItems`	bit boolean	1 if unavailable items are cancelled after the forced shipment (`OHCancelAfterForcedShipOut`).
`PartialDeliveryForRemaining`	bit boolean	1 if the remaining items may also be shipped in further partial deliveries (`OHMultiForceToPicklist`).

Response example

<SqlRowSet1>
  <row>
    <OrderNr>123456</OrderNr>
    <PartialDeliveryActive>1</PartialDeliveryActive>
    <CancelUnavailableItems>0</CancelUnavailableItems>
    <PartialDeliveryForRemaining>1</PartialDeliveryForRemaining>
  </row>
</SqlRowSet1>

POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
Authorization: Basic BASE64(USERNAME:PASSWORD)

<?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/">
  <SOAP-ENV:Body>
    <ns1:pixiGetPartialDeliveryStatus>
      <OrderNr>123456</OrderNr>
    </ns1:pixiGetPartialDeliveryStatus>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

curl -X POST 'https://apigateway.descartes.com/tms/pixi/' \
  --user 'USERNAME:PASSWORD' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --data-binary @- <<'XML'
<?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/">
  <SOAP-ENV:Body>
    <ns1:pixiGetPartialDeliveryStatus>
      <OrderNr>123456</OrderNr>
    </ns1:pixiGetPartialDeliveryStatus>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML

<?php

$soapClient = new SoapClient(null, [
    'login' => 'USERNAME',
    'password' => 'PASSWORD',
    'location' => 'https://apigateway.descartes.com/tms/pixi/',
    'uri' => 'https://apigateway.descartes.com/tms/pixi/',
]);

$arguments = [
    'OrderNr' => '123456',
];

$soapArguments = [];
foreach ($arguments as $name => $value) {
    $soapArguments[] = new SoapVar($value, XSD_STRING, '', '', $name);
}

$response = $soapClient->__soapCall('pixiGetPartialDeliveryStatus', $soapArguments);

SQL object:: dbo.pipiGetPartialDeliveryStatus