Unofficial Pixi-API-Documentation

by koempf24.de

pixiPicklistDelete

Pixi-Docs
Old Pixi-Docs

API call deletes a specified picklist

Since pixi version: 20.03 (9.0.13.47258) Additional notes: If the picklist is currently in use the API call will not allow the deletion of the picklist.

    The deletion of the picklist is still possible with the use of "ForceDelete" parameter, but this might lead to unpredictable behavior.
Orderlines Orders

Request

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

Request body

Name Type Required Description
ForceDelete boolean false

Force the deletion of picklist even if it is currently in use

Type: bit

Default value: 0

Example: 1

Available from: 20.03 (9.0.13.47258)
PicklistNumber integer true

Picklist number

Type: int

Default value: NULL

Example: 123

Available from: 20.03 (9.0.13.47258)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiPicklistDelete>
      <PicklistNumber>0</PicklistNumber>
      <ForceDelete>true</ForceDelete>
    </pixiPicklistDelete>
  </Body>
</Envelope>

Response

1. Status output

Name Type Description
Status string

Execution status (SUCCESS/ERROR)

Type: varchar (20)

Available from: 25.06 (25.6.0.58802)
Message string

Description of the status

Type: varchar (200)

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiPicklistDeletePost200TextXmlResponse>
  <Status>string</Status>
  <Message>string</Message>
</PixiPicklistDeletePost200TextXmlResponse>

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:pixiPicklistDelete>
            <ForceDelete xsi:type="xsd:boolean">1</ForceDelete>
            <PicklistNumber xsi:type="xsd:integer">123</PicklistNumber> <!-- required -->
        </ns1:pixiPicklistDelete>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiPicklistDelete', [
    'ForceDelete' => '1', // boolean
    'PicklistNumber' => '123', // 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);
}