pixiRequestPartialDelivery · Pixi API documentation

Changes the partial delivery settings in the header of one order.

The overall state of the order is determined from its order lines:
- CLOSED – all lines are in a final state, or the order has no order lines at all (this also applies to order numbers that do not exist).
- HOLD – every line is either in status HAL, in status MIN or in a final state.
- OPEN – otherwise.
Only if the state is neither CLOSED nor HOLD, the order header with OrderNr = @OrderNr is updated:
- ForceToPicklistIfNotFULL is set to 1 if @PartialDeliveryActive is 1; if it is 0 or NULL, the field is set to NULL (partial delivery off). This value is always written.
- OHCancelAfterForcedShipOut is set to @CancelUnavailableItems; if the parameter is omitted or NULL, the current value is kept.
- OHMultiForceToPicklist is set to @PartialDeliveryForRemaining; if the parameter is omitted or NULL, the current value is kept.
The number of affected rows is returned in the column RowsUpdated (1 if the order header was updated).

Notes

No error is raised if the order is closed, on hold or does not exist; the call simply performs no update. Check RowsUpdated to see whether the change was applied.
RowsUpdated is read from @@ROWCOUNT after the conditional update. If the update is skipped, the value is not explicitly set to 0 but taken from SQL Server's row count handling of the preceding statements; do not rely on it alone to distinguish states – query the order state separately if exact feedback is needed.
Unlike the other two flags, @PartialDeliveryActive has no keep-current fallback: passing NULL switches partial delivery off.
The order state is determined with NOLOCK reads on order lines, so concurrently changing lines may lead to a slightly outdated state check.
No explicit transaction is used.

Tables used

OrderHeader · Write Orderlines · Read OrderStates · Read

Parameter	Type	Default	Description
`OrderNr` Required	int	–	Internal Pixi order number (`OrderHeader.OrderNr`) of the order to change. Example: `123456`
`PartialDeliveryActive` Required	bit boolean	–	Switches partial delivery on or off (`ForceToPicklistIfNotFULL`). `1` sets the flag, `0` or `NULL` clears it to `NULL`. Allowed values `1` – Partial delivery active: order may be put on a picklist even if not fully available. `0` – Partial delivery off (field set to NULL). Example: `1`
`CancelUnavailableItems`	bit boolean	NULL	Value for `OHCancelAfterForcedShipOut` (cancel unavailable items after the forced partial shipment). `NULL` keeps the current value. Example: `0`
`PartialDeliveryForRemaining`	bit boolean	NULL	Value for `OHMultiForceToPicklist` (allow further partial deliveries for the remaining items). `NULL` keeps the current value. Example: `1`

Result set 1 · Always

Number of order header rows updated.

Column	Type	Description
`RowsUpdated`	int	Value of `@@ROWCOUNT`; `1` if the order header was updated.

Response example

<SqlRowSet1>
  <row>
    <RowsUpdated>1</RowsUpdated>
  </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:pixiRequestPartialDelivery>
      <OrderNr>123456</OrderNr>
      <PartialDeliveryActive>1</PartialDeliveryActive>
      <!-- <CancelUnavailableItems>0</CancelUnavailableItems> -->
      <!-- <PartialDeliveryForRemaining>1</PartialDeliveryForRemaining> -->
    </ns1:pixiRequestPartialDelivery>
  </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:pixiRequestPartialDelivery>
      <OrderNr>123456</OrderNr>
      <PartialDeliveryActive>1</PartialDeliveryActive>
      <!-- <CancelUnavailableItems>0</CancelUnavailableItems> -->
      <!-- <PartialDeliveryForRemaining>1</PartialDeliveryForRemaining> -->
    </ns1:pixiRequestPartialDelivery>
  </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',
    'PartialDeliveryActive' => '1',
    // 'CancelUnavailableItems' => '0',
    // 'PartialDeliveryForRemaining' => '1',
];

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

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