Unofficial Pixi-API-Documentation

by koempf24.de

pixiCanCancelOrderline

Pixi-Docs
Old Pixi-Docs

Use this function to determine, whether a given orderline is in a state where it is possible to cancel it.

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

Orderlines Orders

Request

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

Request body

Name Type Required Description
OrderlineKey integer false

[optional] Inspected orderline's ID

Type: int

Default value:

Example:

Available from: LOU Official (6.3.0.4452)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiCanCancelOrderline>
      <OrderlineKey>0</OrderlineKey>
    </pixiCanCancelOrderline>
  </Body>
</Envelope>

Response

Name Type Description
return integer

1 - it is possible to cancel, 0 - it is not possible to cancel

Type: int

Available from: LOU Official (6.3.0.4452)

Response Example

<PixiCanCancelOrderlinePost200TextXmlResponse>
  <return>0</return>
</PixiCanCancelOrderlinePost200TextXmlResponse>

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:pixiCanCancelOrderline>
            <OrderlineKey xsi:type="xsd:integer"></OrderlineKey>
        </ns1:pixiCanCancelOrderline>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiCanCancelOrderline', [
    'OrderlineKey' => '', // integer
]);

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);
}