Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetItemTags

Pixi-Docs
Old Pixi-Docs

Returns all Tags for Items or only System Tags for Items.

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

Items Stock

Request

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

Request body

Name Type Required Description
SystemTags boolean false

If value is 1, returns all Tags including System Tags. If value is 0, returns only normal tags.

Type: bit

Default value: 0

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetItemTags>
      <SystemTags>true</SystemTags>
    </pixiGetItemTags>
  </Body>
</Envelope>

Response

1. Result set

Name Type Description
TagKey integer

Tag Key

Type: int

Available from: 25.06 (25.6.0.58802)
TagName string

Tag Name

Type: varchar

Available from: 25.06 (25.6.0.58802)
TagDescription string

Tag description

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetItemTagsPost200TextXmlResponse>
  <TagKey>0</TagKey>
  <TagName>string</TagName>
  <TagDescription>string</TagDescription>
</PixiGetItemTagsPost200TextXmlResponse>

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:pixiGetItemTags>
            <SystemTags xsi:type="xsd:boolean"></SystemTags>
        </ns1:pixiGetItemTags>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetItemTags', [
    'SystemTags' => '', // boolean
]);

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