pixiGetItemTags · Pixi API documentation

Reads all tags of type TypeId = 1 (item tags) from the Tag table.

With SystemTags = 0 (default) only user-defined tags are returned (IsSystemTag = 0).
With SystemTags = 1 system tags are included as well.

The result is sorted by tag name in ascending order. Each row contains the tag key, name and description.

Notes

The table is read with NOLOCK, so uncommitted changes may be visible. The header comment of the procedure ("Template for getting items…") is a leftover from a template and does not describe the actual behaviour. Any value of SystemTags other than 1 behaves like 0.

Tables used

Tag · Read

Parameter Type Default Description

Parameter	Type	Default	Description
`SystemTags`	bit boolean	0	Controls whether system tags are included in the result. Allowed values `0` – Only non-system item tags (default). `1` – All item tags including system tags. Example: `0`

SystemTags

bit
boolean

0

Controls whether system tags are included in the result.

Allowed values

0 – Only non-system item tags (default).
1 – All item tags including system tags.

Example: 0

Result set 1 · Always

Item tags sorted by name ascending.

Column	Type	Description
`TagKey`	int	Unique key of the tag (`Tag.Id`).
`TagName` Nullable	string	Name of the tag.
`TagDescription` Nullable	string	Description of the tag.

Response example

<SqlRowSet1>
  <row>
    <TagKey>12</TagKey>
    <TagName>Bestseller</TagName>
    <TagDescription>Top-selling items</TagDescription>
  </row>
  <row>
    <TagKey>15</TagKey>
    <TagName>Sale</TagName>
    <TagDescription>Items on sale</TagDescription>
  </row>
</SqlRowSet1>

POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
Authorization: Basic BASE64(USERNAME:PASSWORD)

<?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/">
  <SOAP-ENV:Body>
    <ns1:pixiGetItemTags>
      <!-- <SystemTags>0</SystemTags> -->
    </ns1:pixiGetItemTags>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

curl -X POST 'https://apigateway.descartes.com/tms/pixi/' \
  --user 'USERNAME:PASSWORD' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --data-binary @- <<'XML'
<?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/">
  <SOAP-ENV:Body>
    <ns1:pixiGetItemTags>
      <!-- <SystemTags>0</SystemTags> -->
    </ns1:pixiGetItemTags>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML

<?php

$soapClient = new SoapClient(null, [
    'login' => 'USERNAME',
    'password' => 'PASSWORD',
    'location' => 'https://apigateway.descartes.com/tms/pixi/',
    'uri' => 'https://apigateway.descartes.com/tms/pixi/',
]);

$arguments = [
    // 'SystemTags' => '0',
];

$soapArguments = [];
foreach ($arguments as $name => $value) {
    $soapArguments[] = new SoapVar($value, XSD_STRING, '', '', $name);
}

$response = $soapClient->__soapCall('pixiGetItemTags', $soapArguments);