pixiReadItemTagMatching · Pixi API documentation

Reads tag assignments from TagMatch and returns only those whose tag in Tag has TypeId = 1. According to the code comment, these are item tags.

Only assignments with an ID greater than @Start are returned.
At most @RowCount rows are returned.
Rows are sorted by the assignment ID (ItemMatchKey) in ascending order.

Paging: @Start is not a row offset. It is the last ItemMatchKey already received. To read all assignments, start with Start = 0. Then call again with Start set to the highest ItemMatchKey of the previous page. Stop when fewer than RowCount rows come back.

Notes

Both tables are read with NOLOCK, so uncommitted changes may be visible and rows may be missing or duplicated under concurrent writes.
The meaning of TypeId = 1 (item tags) is taken from the procedure comment; other tag types are ignored.
The call returns only IDs. Tag names and item details must be read with other calls.

Tables used

TagMatch · Read Tag · Read

Parameter	Type	Default	Description
`Start`	int	0	Only assignments with an ID (`ItemMatchKey`) greater than this value are returned. Pass the last `ItemMatchKey` of the previous page to get the next page. Example: `0`
`RowCount`	int	1000	Maximum number of rows to return. Example: `1000`

Result set 1 · Always (may be empty).

Assignments of item tags to items, sorted by ItemMatchKey ascending.

Column	Type	Description
`ItemMatchKey`	int	ID of the tag assignment (`TagMatch.Id`). Use it as the paging key.
`TagRef`	int	ID of the assigned tag (`TagMatch.TagId`).
`ItemRef`	int	ID of the item the tag is assigned to (`TagMatch.ItemId`).

Response example

<SqlRowSet1>
  <row>
    <ItemMatchKey>101</ItemMatchKey>
    <TagRef>5</TagRef>
    <ItemRef>23817</ItemRef>
  </row>
  <row>
    <ItemMatchKey>102</ItemMatchKey>
    <TagRef>7</TagRef>
    <ItemRef>23817</ItemRef>
  </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:pixiReadItemTagMatching>
      <!-- <Start>0</Start> -->
      <!-- <RowCount>1000</RowCount> -->
    </ns1:pixiReadItemTagMatching>
  </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:pixiReadItemTagMatching>
      <!-- <Start>0</Start> -->
      <!-- <RowCount>1000</RowCount> -->
    </ns1:pixiReadItemTagMatching>
  </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' => '1000',
];

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

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