Unofficial Pixi-API-Documentation

by koempf24.de

pixiRequestPartialDelivery

Pixi-Docs
Old Pixi-Docs

The call sets a partial delivery for the specified customer order.

Since pixi version: LOU Official (6.3.0.4452) Additional notes:

Orderlines Orders

Request

POST https://apigateway.descartes.com/tms/pixi/pixiRequestPartialDelivery

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)
PartialDeliveryActive boolean true

If set to 1, order is forced to picklist even uin all aitems are not available.

Type: bit

Default value:

Example: 1

Available from: LOU Official (6.3.0.4452)
CancelUnavailableItems boolean false

If set to 1, orderlines with unavaliable items are cancelled.

Type: bit

Default value: NULL

Example: 1

Available from: LOU Official (6.3.0.4452)
PartialDeliveryForRemaining boolean false

If set to 1, orderlines with unavaliable items will be reprocessed later.

Type: bit

Default value: NULL

Example: 1

Available from: LOU Official (6.3.0.4452)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiRequestPartialDelivery>
      <OrderNr>0</OrderNr>
      <PartialDeliveryActive>true</PartialDeliveryActive>
      <CancelUnavailableItems>true</CancelUnavailableItems>
      <PartialDeliveryForRemaining>true</PartialDeliveryForRemaining>
    </pixiRequestPartialDelivery>
  </Body>
</Envelope>

Response

1. Return status

Name Type Description
RowsUpdated integer

Returns the number of updated rows. Should be either 1 (success) or 0 (failure). The update may fail if, for example, OrderNr is invalid or if the whole order is closed or is on hold (same conditions that would make the Ship Now button in Customer Service application disabled)

Type: int

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiRequestPartialDeliveryPost200TextXmlResponse>
  <RowsUpdated>0</RowsUpdated>
</PixiRequestPartialDeliveryPost200TextXmlResponse>

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:pixiRequestPartialDelivery>
            <OrderNr xsi:type="xsd:integer">123456</OrderNr> <!-- required -->
            <PartialDeliveryActive xsi:type="xsd:boolean">1</PartialDeliveryActive> <!-- required -->
            <CancelUnavailableItems xsi:type="xsd:boolean">1</CancelUnavailableItems>
            <PartialDeliveryForRemaining xsi:type="xsd:boolean">1</PartialDeliveryForRemaining>
        </ns1:pixiRequestPartialDelivery>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiRequestPartialDelivery', [
    'OrderNr' => '123456', // integer (required)
    'PartialDeliveryActive' => '1', // boolean (required)
    'CancelUnavailableItems' => '1', // boolean
    'PartialDeliveryForRemaining' => '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);
}