Unofficial Pixi-API-Documentation

by koempf24.de

pixiTagUpdate

Pixi-Docs
Old Pixi-Docs

Update tag name and description by tag id.

Since pixi version: 19.06 (9.0.4.39859) Additional notes:

Orderlines Orders

Request

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

Request body

Name Type Required Description
Name string true

New tag name.

Type: varchar(50)

Default value: NULL

Example:

Available from: 19.06 (9.0.4.39859)
TagId integer true

Id of the Tag which will be updated.

Type: int

Default value: NULL

Example:

Available from: 19.06 (9.0.4.39859)
Description string false

(optional) New description of the tag. If description is NULL, then existing tag description is not changed.

Type: varchar(4000)

Default value: NULL

Example:

Available from: 19.06 (9.0.4.39859)

Request Example

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

Response

1. Return status

Name Type Description
Status string

Result of API Call

Type: varchar(10)

Available from: 25.06 (25.6.0.58802)
Message string

Extended Result of API Call

Type: varchar(100)

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiTagUpdatePost200TextXmlResponse>
  <Status>string</Status>
  <Message>string</Message>
</PixiTagUpdatePost200TextXmlResponse>

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

PHP Example

<?php

getPixiSoapClientResponse('pixiTagUpdate', [
    'Name' => '', // string (required)
    'TagId' => '', // integer (required)
    'Description' => '', // string
]);

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