pixiGetItemLogistics · Pixi API documentation

Returns master data of items for an external fulfillment provider.

Filter

Only items with Enabled = 1 (active items).
Only items with IsBundle = 0. Bundle items themselves are not returned.
Only items with ItemKey greater than StartKey.

Paging

The result is sorted by ItemKey ascending and limited to RowCount rows.
To read the next page, pass the highest ItemKey of the previous page as StartKey. Stop when fewer than RowCount rows are returned.

VPE (packaging unit)

An item gets its OrderUnit (or 1 if OrderUnit is NULL) as VPE if it is the only component of at least one bundle and the bundle quantity of that component equals the item's OrderUnit (cast to integer). Such bundles represent a packaging unit of the item.
All other items get VPE = 1.

Tags

Tags contains the names of all tags assigned to the item, sorted alphabetically and separated by |. Empty string if the item has no tags.

Notes

All tables are read with NOLOCK; results may contain uncommitted data.
OrderUnit is cast to INT for the comparison with the bundle quantity; fractional order units are truncated in that check.
The tag string is built per row by the scalar function fpixi_GetItemTAGsAsString and is limited to 8000 characters; large RowCount values can be slow.
The exact data types of ItemName and OrderUnit are defined in the items table and are not visible in the code.

Tables used

items · Read BundleItems · Read Tag · Read TagMatch · Read

Parameter	Type	Default	Description
`StartKey`	int	0	Only items with an `ItemKey` greater than this value are returned. Use 0 for the first page, then the last `ItemKey` of the previous page. Example: `0`
`RowCount`	int	1000	Maximum number of rows returned per call. Example: `500`

Result set 1 · Always

Active, non-bundle items with ItemKey > StartKey, sorted by ItemKey ascending, at most RowCount rows.

Column	Type	Description
`ItemKey`	int	Internal key of the item; use the last value as `StartKey` for the next page.
`ItemName` Nullable	string	Name of the item.
`VPE`	decimal	Packaging unit: the item's `OrderUnit` if the item is the only component of a bundle whose quantity equals the `OrderUnit`, otherwise 1.
`Tags`	varchar(8000) string	Tag names of the item, sorted alphabetically and separated by `\|`; empty string if none.

Response example

<SqlRowSet1>
  <row>
    <ItemKey>1012</ItemKey>
    <ItemName>Kaffeebecher Keramik 300 ml</ItemName>
    <VPE>6</VPE>
    <Tags>Fragile|Kitchen</Tags>
  </row>
  <row>
    <ItemKey>1015</ItemKey>
    <ItemName>Teelöffel Edelstahl</ItemName>
    <VPE>1</VPE>
    <Tags/>
  </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:pixiGetItemLogistics>
      <!-- <StartKey>0</StartKey> -->
      <!-- <RowCount>500</RowCount> -->
    </ns1:pixiGetItemLogistics>
  </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:pixiGetItemLogistics>
      <!-- <StartKey>0</StartKey> -->
      <!-- <RowCount>500</RowCount> -->
    </ns1:pixiGetItemLogistics>
  </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 = [
    // 'StartKey' => '0',
    // 'RowCount' => '500',
];

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

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