Shipping Read

pixiShippingGetPicklistDetails

Returns the positions of a picklist grouped by item, bin and order line, with bin, item, order and box details, optionally filtered by location, bin group and bin name.

Reads the picklist header (PLheader) identified by PicklistKey together with its picklist items (PLItem). Each picklist item is joined to the bin item (InvBinItem), the item (Items), the bin (InvBin) and the order line (Orderlines).

The picklist items are grouped per item, bin and order line. Qty is the number of picklist item rows in each group. Item numbers (ItemNrSuppl, EanUpc, ItemNrInt) are returned in upper case.

For every group the call also returns:

OtherItemsCount: 1 if the bin holds other items than this one, otherwise 0
PLHfromBox / PLHtoBox of the picklist header
BundleItemName: the name of the bundle order line, or an empty string
TotalItemsOnBin: total quantity of all items on the bin
TotalSimilarItemsOnBin: total quantity of this item on the bin

Optional filters, each ignored when NULL or empty:

FilterLocation: exact match on the bin's location ID
FilterBinGroup: LIKE match on the bin group, so wildcards such as % work
FilterBinName: LIKE match on the bin name, so wildcards such as % work

The rows are sorted by BinGroup, BinSortNum and ItemName, which gives a walking order through the warehouse.

Notes

PicklistKey has a default of NULL, and 0 is also turned into NULL. In both cases no picklist matches, so the result set is empty. In practice the parameter must be sent.
All tables are read with NOLOCK, so uncommitted data can appear.
The column PLIorderlineRef appears twice in the result set (once from the grouped data and once as an explicit extra column). Depending on the client, the second occurrence may be renamed (for example PLIorderlineRef1) or overwrite the first; both hold the same value.
Despite its name, OtherItemsCount is a flag (0/1), not a count.
The grouping also includes the creator of the picklist and the creation date of the order line, which are not returned; rows that look identical can therefore appear more than once.
Data types of most columns depend on the table definitions, which are not part of the code.

Tables used

PLheader · Read PLItem · Read InvBinItem · Read Items · Read InvBin · Read Orderlines · Read BundleOrderlines · Read

Parameter	Type	Default	Description
`PicklistKey`	int	NULL	Key of the picklist (`PLHkey`). `0` or `NULL` returns no rows. Example: `4711`
`FilterLocation`	varchar(3) string	NULL	Optional location ID; only bins of this location are returned (exact match). Empty string means no filter. Example: `001`
`FilterBinGroup`	varchar(20) string	NULL	Optional bin group pattern, compared with `LIKE` (wildcards allowed). Empty string means no filter. Example: `A%`
`FilterBinName`	varchar(50) string	NULL	Optional bin name pattern, compared with `LIKE` (wildcards allowed). Empty string means no filter. Example: `A-01-%`

Result set 1 · Always; empty if the picklist does not exist, `PicklistKey` is 0/NULL or the filters match nothing.

One row per item, bin and order line of the picklist, sorted by bin group, bin sort number and item name.

Column	Type	Description
`BinItemRef`	int	Item key of the bin item (`InvBinItem.BinItemRef`).
`PLIheaderRef`	int	Key of the picklist header.
`BinSortNum` Nullable	int	Sort number of the bin (walking order).
`ItemName` Nullable	string	Item name.
`BinName` Nullable	string	Name of the bin.
`BinKey`	int	Key of the bin.
`PicklistExpiryDate` Nullable	dateTime	Expiry date of the picklist (`PLHexpiryDate`).
`PicklistCreateDate` Nullable	dateTime	Creation date of the picklist.
`Qty`	int	Number of picklist item rows in this group.
`PicklistComment` Nullable	string	Comment of the picklist.
`ItemNrSuppl` Nullable	string	Supplier item number in upper case.
`EanUpc` Nullable	string	EAN/UPC of the item in upper case.
`ItemNrInt` Nullable	string	Internal item number in upper case.
`BinRef` Nullable	int	Bin reference stored on the picklist item (`pliBinRef`).
`BinGroup` Nullable	string	Group of the bin.
`PLIorderlineRef`	int	Key of the order line of the picklist item.
`Location` Nullable	string	Location ID of the bin (`BinLocID`).
`PicLinkSmall`	string	Link to the small item picture, empty string if none.
`PicLinkLarge` Nullable	string	Link to the large item picture.
`OrderNr` Nullable	int	Order number.
`OrderNrExternal` Nullable	string	External order number.
`ItemNrExternal` Nullable	string	External item number.
`BundleOrderlineRef`	int	Key of the bundle order line, `0` if the line is not part of a bundle.
`CustKey` Nullable	int	Customer key (`CustRef`).
`OtherItemsCount`	int	`1` if other items are stored on the same bin, otherwise `0`.
`PLHfromBox` Nullable	string	From-box value of the picklist header.
`PLHtoBox` Nullable	string	To-box value of the picklist header.
`PLIorderlineRef`	int	Second occurrence of the order line key (same value as above).
`BundleItemName`	string	Name of the bundle order line (`ArtName`), empty string if none.
`TotalItemsOnBin` Nullable	int	Sum of `BinItemQTY` of all items on the bin.
`TotalSimilarItemsOnBin` Nullable	int	Sum of `BinItemQTY` of this item on the bin.

Response example

<SqlRowSet1>
  <row>
    <BinItemRef>1234</BinItemRef>
    <PLIheaderRef>4711</PLIheaderRef>
    <BinSortNum>10</BinSortNum>
    <ItemName>T-Shirt Blue M</ItemName>
    <BinName>A-01-03</BinName>
    <BinKey>553</BinKey>
    <PicklistExpiryDate>2024-05-03T18:00:00</PicklistExpiryDate>
    <PicklistCreateDate>2024-05-02T09:15:00</PicklistCreateDate>
    <Qty>2</Qty>
    <PicklistComment>Express</PicklistComment>
    <ItemNrSuppl>TS-BL-M</ItemNrSuppl>
    <EanUpc>4012345678901</EanUpc>
    <ItemNrInt>100234</ItemNrInt>
    <BinRef>553</BinRef>
    <BinGroup>A</BinGroup>
    <PLIorderlineRef>98765</PLIorderlineRef>
    <Location>001</Location>
    <PicLinkSmall>https://shop.example.com/img/s/100234.jpg</PicLinkSmall>
    <PicLinkLarge>https://shop.example.com/img/l/100234.jpg</PicLinkLarge>
    <OrderNr>50123</OrderNr>
    <OrderNrExternal>WEB-2024-0815</OrderNrExternal>
    <ItemNrExternal>SKU-100234</ItemNrExternal>
    <BundleOrderlineRef>0</BundleOrderlineRef>
    <CustKey>3321</CustKey>
    <OtherItemsCount>1</OtherItemsCount>
    <PLHfromBox>1</PLHfromBox>
    <PLHtoBox>20</PLHtoBox>
    <PLIorderlineRef1>98765</PLIorderlineRef1>
    <BundleItemName/>
    <TotalItemsOnBin>35</TotalItemsOnBin>
    <TotalSimilarItemsOnBin>12</TotalSimilarItemsOnBin>
  </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:pixiShippingGetPicklistDetails>
      <!-- <PicklistKey>4711</PicklistKey> -->
      <!-- <FilterLocation>001</FilterLocation> -->
      <!-- <FilterBinGroup>A%</FilterBinGroup> -->
      <!-- <FilterBinName>A-01-%</FilterBinName> -->
    </ns1:pixiShippingGetPicklistDetails>
  </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:pixiShippingGetPicklistDetails>
      <!-- <PicklistKey>4711</PicklistKey> -->
      <!-- <FilterLocation>001</FilterLocation> -->
      <!-- <FilterBinGroup>A%</FilterBinGroup> -->
      <!-- <FilterBinName>A-01-%</FilterBinName> -->
    </ns1:pixiShippingGetPicklistDetails>
  </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 = [
    // 'PicklistKey' => '4711',
    // 'FilterLocation' => '001',
    // 'FilterBinGroup' => 'A%',
    // 'FilterBinName' => 'A-01-%',
];

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

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

SQL object:: dbo.pipiShippingGetPicklistDetails

pixiShippingGetPicklistDetails

Notes

Tables used

Result set 1 · Always; empty if the picklist does not exist, PicklistKey is 0/NULL or the filters match nothing.

Response example

Result set 1 · Always; empty if the picklist does not exist, `PicklistKey` is 0/NULL or the filters match nothing.