Unofficial Pixi-API-Documentation

by koempf24.de

pixiTagDelete

Pixi-Docs
Old Pixi-Docs

Delete tag (tag will be also removed from all assigned objects). System tags can not be deleted. Tags can be removed either by TagId or combination of TypeId and Name parameters.

Since pixi version: 19.06 (9.0.4.39859) Additional notes:

Orderlines Orders

Request

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

Request body

Name Type Required Description
Name string false

Name of the tag which will be deleted (only used in combination with TypeId parameter).

Type: varchar(50)

Default value: NULL

Example:

Available from: 19.06 (9.0.4.39859)
TagId integer false

Id of the tag which will be deleted.

Type: int

Default value: NULL

Example:

Available from: 19.06 (9.0.4.39859)
TypeId integer false

Type of the tag (only used in combination with Name parameter).

Type: int

Default value: NULL

Example:

Available from: 19.06 (9.0.4.39859)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiTagDelete>
      <TagId>0</TagId>
      <TypeId>0</TypeId>
      <Name>string</Name>
    </pixiTagDelete>
  </Body>
</Envelope>

Response

1. Return status

Name Type Description
Status string

Result of API Ca�ll

Type: varchar(10)

Available from: 25.06 (25.6.0.58802)
Message string

Extended Result of API Ca�ll

Type: varchar(100)

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiTagDeletePost200TextXmlResponse>
  <Status>string</Status>
  <Message>string</Message>
</PixiTagDeletePost200TextXmlResponse>

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:pixiTagDelete>
            <Name xsi:type="xsd:string"></Name>
            <TagId xsi:type="xsd:integer"></TagId>
            <TypeId xsi:type="xsd:integer"></TypeId>
        </ns1:pixiTagDelete>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiTagDelete', [
    'Name' => '', // string
    'TagId' => '', // integer
    'TypeId' => '', // 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);
}