pixiGetCategories · Pixi API documentation

Reads the category master data from TontrArten and returns key, short code and description of each category.

Empty values are normalized first: TontrArtKey = 0 and empty strings for TontrShort or TontrText are treated as NULL.

Only one filter is applied, chosen in this order of priority:

If TontrArtKey is set, only the category with this key is returned.
Otherwise, if TontrShort is set, categories whose short code matches exactly are returned.
Otherwise, if TontrText is set, categories whose text matches exactly are returned.
If no parameter is set, all categories are returned.

The result is always sorted by TontrText ascending.

Notes

Filters are not combined: if several parameters are passed, only the one with the highest priority (TontrArtKey > TontrShort > TontrText) is used; the others are ignored.
Matching is exact (=), no wildcard or partial search.
The table is read WITH (NOLOCK), so uncommitted changes may be visible.
If nothing matches, an empty result set is returned; there is no error row.

Tables used

TontrArten · Read

Parameter	Type	Default	Description
`TontrArtKey`	int	NULL	Key of the category. `0` is treated as `NULL`. Has the highest filter priority. Example: `3`
`TontrShort`	varchar(50) string	NULL	Short code of the category (exact match). Empty string is treated as `NULL`. Used only if `TontrArtKey` is not set. Example: `BOOK`
`TontrText`	varchar(50) string	NULL	Description text of the category (exact match). Empty string is treated as `NULL`. Used only if neither `TontrArtKey` nor `TontrShort` is set. Example: `Books`

Result set 1 · Always (may be empty if no category matches).

Matching categories, sorted by TontrText ascending.

Column	Type	Description
`TontrArtKey`	int	Key of the category.
`TontrShort` Nullable	varchar(50) string	Short code of the category.
`TontrText` Nullable	varchar(50) string	Description text of the category.

Response example

<SqlRowSet1>
  <row>
    <TontrArtKey>3</TontrArtKey>
    <TontrShort>BOOK</TontrShort>
    <TontrText>Books</TontrText>
  </row>
  <row>
    <TontrArtKey>5</TontrArtKey>
    <TontrShort>CD</TontrShort>
    <TontrText>Music CDs</TontrText>
  </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:pixiGetCategories>
      <!-- <TontrArtKey>3</TontrArtKey> -->
      <!-- <TontrShort>BOOK</TontrShort> -->
      <!-- <TontrText>Books</TontrText> -->
    </ns1:pixiGetCategories>
  </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:pixiGetCategories>
      <!-- <TontrArtKey>3</TontrArtKey> -->
      <!-- <TontrShort>BOOK</TontrShort> -->
      <!-- <TontrText>Books</TontrText> -->
    </ns1:pixiGetCategories>
  </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 = [
    // 'TontrArtKey' => '3',
    // 'TontrShort' => 'BOOK',
    // 'TontrText' => 'Books',
];

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

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