pixiReadItemTags · Pixi API documentation

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

Only tags whose key is greater than Start are returned.
The result is sorted by TagKey ascending and limited to RowCount rows.
If RowCount is NULL or less than 1, 1000 rows are returned.

Paging: to read the next page, pass the highest TagKey of the previous page as Start. Repeat until fewer than RowCount rows come back.

Notes

The table is read with NOLOCK, so uncommitted changes may be visible. Tags of other types (other TypeId values) are not returned. The call only lists tag definitions; it does not return which items carry a tag.

Tables used

Tag · Read

Parameter	Type	Default	Description
`Start`	int	-99999999	Only tags with a key greater than this value are returned. Use the last `TagKey` of the previous page for paging. Example: `0`
`RowCount`	int	1000	Maximum number of rows to return. `NULL` or values below 1 are replaced by 1000. Example: `500`

Result set 1 · Always

Item tags with a key greater than Start, sorted by TagKey ascending, at most RowCount rows.

Column	Type	Description
`TagKey`	int	Unique key of the tag.
`TagName` Nullable	string	Name of the tag.
`TagDescription` Nullable	string	Description of the tag.
`IsSystemTag` Nullable	boolean	Indicates whether the tag is a system tag.

Response example

<SqlRowSet1>
  <row>
    <TagKey>3</TagKey>
    <TagName>Bestseller</TagName>
    <TagDescription>Top selling items</TagDescription>
    <IsSystemTag>false</IsSystemTag>
  </row>
  <row>
    <TagKey>7</TagKey>
    <TagName>Fragile</TagName>
    <TagDescription>Handle with care</TagDescription>
    <IsSystemTag>false</IsSystemTag>
  </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:pixiReadItemTags>
      <!-- <Start>0</Start> -->
      <!-- <RowCount>500</RowCount> -->
    </ns1:pixiReadItemTags>
  </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:pixiReadItemTags>
      <!-- <Start>0</Start> -->
      <!-- <RowCount>500</RowCount> -->
    </ns1:pixiReadItemTags>
  </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 = [
    // 'Start' => '0',
    // 'RowCount' => '500',
];

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

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