Unofficial Pixi-API-Documentation

by koempf24.de

pixiDeleteOrder

Pixi-Docs
Old Pixi-Docs

Call deletes order and the corresponding customer account event. The order can only be deleted if all the orderliens have status "ANG","HAL" or "STO"

Since pixi version: AVA Official - Update 7 (8.4.7.23158) Additional notes:

Orderlines Orders

Request

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

Request body

Name Type Required Description
OrderNr integer true

pixi* OrderNr of the order to delete

Type: int

Default value:

Example: 12345

Available from: AVA Official - Update 7 (8.4.7.23158)

Request Example

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

Response

1. Status of the operation

Name Type Description
Status string

Result code of the operation: 200 = Success, 4** = Logical errors (check ErrorMsg for details), 500 = Unexpected errors

Type: varchar(3)

Available from: 25.06 (25.6.0.58802)
ErrorMsg string

Descriptive text for the operation's result

Type: varchar(2000)

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiDeleteOrderPost200TextXmlResponse>
  <Status>string</Status>
  <ErrorMsg>string</ErrorMsg>
</PixiDeleteOrderPost200TextXmlResponse>

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:pixiDeleteOrder>
            <OrderNr xsi:type="xsd:integer">12345</OrderNr> <!-- required -->
        </ns1:pixiDeleteOrder>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiDeleteOrder', [
    'OrderNr' => '12345', // 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);
}