Unofficial Pixi-API-Documentation

by koempf24.de

pixiDeleteDelivery

Pixi-Docs
Old Pixi-Docs

Delete delivery.

Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:

Suppliers

Request

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

Request body

Name Type Required Description
SDelHkey integer false

SDelHkey

Type: int

Default value: NULL

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)
PiccoUser string false

PiccoUser

Type: varchar(50)

Default value: NULL

Example: Metka

Available from: LOU Official - Update 46 (6.9.46.27927)
DeliveryNumber integer false

DeliveryNumber

Type: int

Default value: NULL

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiDeleteDelivery>
      <SDelHkey>0</SDelHkey>
      <DeliveryNumber>0</DeliveryNumber>
      <PiccoUser>string</PiccoUser>
    </pixiDeleteDelivery>
  </Body>
</Envelope>

Response

1. Status output

Name Type Description
ReturnMSG string

Return message

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiDeleteDeliveryPost200TextXmlResponse>
  <ReturnMSG>string</ReturnMSG>
</PixiDeleteDeliveryPost200TextXmlResponse>

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:pixiDeleteDelivery>
            <SDelHkey xsi:type="xsd:integer">123</SDelHkey>
            <PiccoUser xsi:type="xsd:string">Metka</PiccoUser>
            <DeliveryNumber xsi:type="xsd:integer">123</DeliveryNumber>
        </ns1:pixiDeleteDelivery>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiDeleteDelivery', [
    'SDelHkey' => '123', // integer
    'PiccoUser' => 'Metka', // string
    'DeliveryNumber' => '123', // 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);
}