pixiTagGet · Pixi API documentation

Returns the tags defined in Pixi (table Tag) joined with their tag type (TagType).

DateFrom / DateTo filter on the creation date of the tag (RecordCreatedOn, inclusive on both ends). If DateFrom is omitted, the creation date of the oldest tag is used. If DateTo is omitted, the current date and time is used.
TypeId restricts the result to one tag type. If it is omitted, tags of all types are returned.
RowCount limits the number of rows (default 1000, also used if NULL is passed).

Only tags whose TypeId exists in TagType are returned (inner join). The result is sorted by TagId ascending.

Notes

All reads use NOLOCK, so uncommitted data may be returned.
The date parameters are smalldatetime (minute precision); seconds are rounded.
There is no offset parameter. To page through many tags, narrow the date range or increase RowCount.
The call returns tag definitions only, not the assignments of tags to objects.

Tables used

Tag · Read TagType · Read

Parameter	Type	Default	Description
`RowCount`	int	1000	Maximum number of rows returned. `NULL` is treated as 1000. Example: `500`
`DateFrom`	smalldatetime dateTime	NULL	Start of the creation date range (inclusive). If `NULL`, the creation date of the oldest tag is used. Example: `2024-01-01T00:00:00`
`DateTo`	smalldatetime dateTime	NULL	End of the creation date range (inclusive). If `NULL`, the current date and time is used. Example: `2024-12-31T23:59:00`
`TypeId`	int	NULL	ID of the tag type (`TagType.Id`) to filter on. `NULL` returns tags of all types. Example: `1`

Result set 1 · Always

One row per tag matching the filters, sorted by TagId.

Column	Type	Description
`TagId`	int	ID of the tag.
`Name` Nullable	string	Name of the tag.
`Description` Nullable	string	Description of the tag.
`IsSystemTag` Nullable	boolean	Flag whether the tag is a system tag.
`CreateDate` Nullable	dateTime	Creation date of the tag (`Tag.RecordCreatedOn`).
`TypeId`	int	ID of the tag type.
`TypeName` Nullable	string	Name of the tag type (`TagType.Name`).

Response example

<SqlRowSet1>
  <row>
    <TagId>1</TagId>
    <Name>Express</Name>
    <Description>Express shipping requested</Description>
    <IsSystemTag>false</IsSystemTag>
    <CreateDate>2024-03-12T09:15:00</CreateDate>
    <TypeId>1</TypeId>
    <TypeName>Order</TypeName>
  </row>
  <row>
    <TagId>2</TagId>
    <Name>Fragile</Name>
    <Description>Handle with care</Description>
    <IsSystemTag>true</IsSystemTag>
    <CreateDate>2024-03-14T11:40:00</CreateDate>
    <TypeId>2</TypeId>
    <TypeName>Item</TypeName>
  </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:pixiTagGet>
      <!-- <RowCount>500</RowCount> -->
      <!-- <DateFrom>2024-01-01T00:00:00</DateFrom> -->
      <!-- <DateTo>2024-12-31T23:59:00</DateTo> -->
      <!-- <TypeId>1</TypeId> -->
    </ns1:pixiTagGet>
  </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:pixiTagGet>
      <!-- <RowCount>500</RowCount> -->
      <!-- <DateFrom>2024-01-01T00:00:00</DateFrom> -->
      <!-- <DateTo>2024-12-31T23:59:00</DateTo> -->
      <!-- <TypeId>1</TypeId> -->
    </ns1:pixiTagGet>
  </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 = [
    // 'RowCount' => '500',
    // 'DateFrom' => '2024-01-01T00:00:00',
    // 'DateTo' => '2024-12-31T23:59:00',
    // 'TypeId' => '1',
];

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

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