pixiGetItemStatus · Pixi API documentation

Looks up a single item and returns its enabled status.

The item is resolved from table Items. A row matches if its ItemKey equals ItemKey (only when ItemKey is passed) or its ItemNrInt equals ItemNrInt. The first matching row (TOP 1, no sort order) provides the item key.
The procedure then returns ItemKey, ItemNrInt and Enabled of that item.

If neither parameter matches an item, or both parameters are left out, the result set is empty.

Notes

Both parameters are combined with OR. If both are passed and refer to different items, it is not defined which item is returned (TOP 1 without ORDER BY). Pass only one of them.
If ItemKey is passed but does not exist and ItemNrInt does not match either, the result set is simply empty; no error is returned.
If ItemKey does not exist but ItemNrInt matches, the item found by ItemNrInt is returned.
Reads with NOLOCK, so uncommitted changes may be visible.
The data type and meaning of the values of Enabled are not visible in the code.

Tables used

Items · Read

Parameter	Type	Default	Description
`ItemNrInt`	varchar(50) string	NULL	Internal item number of the item. Used if `ItemKey` is not passed or does not match. Example: `ART-100234`
`ItemKey`	int	NULL	Internal key of the item in table `Items`. Example: `4711`

Result set 1 · Always; contains one row if an item was found, otherwise no rows.

Status of the resolved item.

Column	Type	Description
`ItemKey`	int	Internal key of the item.
`ItemNrInt` Nullable	varchar(50) string	Internal item number.
`Enabled` Nullable	string	Active/inactive flag of the item as stored in `Items.Enabled`.

Response example

<SqlRowSet1>
  <row>
    <ItemKey>4711</ItemKey>
    <ItemNrInt>ART-100234</ItemNrInt>
    <Enabled>1</Enabled>
  </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:pixiGetItemStatus>
      <!-- <ItemNrInt>ART-100234</ItemNrInt> -->
      <!-- <ItemKey>4711</ItemKey> -->
    </ns1:pixiGetItemStatus>
  </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:pixiGetItemStatus>
      <!-- <ItemNrInt>ART-100234</ItemNrInt> -->
      <!-- <ItemKey>4711</ItemKey> -->
    </ns1:pixiGetItemStatus>
  </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 = [
    // 'ItemNrInt' => 'ART-100234',
    // 'ItemKey' => '4711',
];

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

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