Stock Read

pixiGetItemsOnStockBinPickList

Returns the items stored on a bin, the items from that bin on open pick lists and in boxes, plus a combined status code.

Looks up the bin by BinName and LocID in InvBin and then returns four result sets.

Items on the bin from InvBinItem joined with Items, with EAN, internal and supplier item number and the summed quantity as StockLevel.
- GroupItems = 0 (default): one row per item and UpdateDate of the bin entry, sorted by UpdateDate.
- GroupItems = 1: one row per item; UpdateDate is the latest update date, sorted by it.
Pick list entries from PLitem for this bin that are not expired (Expired = 0) and whose order line status is not AUS, NLB, RET, STO or EIN. Grouped by item and pick list; Sum_PickListItem is the number of pick list positions. No explicit sort order.
Box contents: pick list entries for this bin that are not expired and whose order line has status EIN, joined with boxitems and boxes. Grouped by item and box number; sum_box_item is the summed box quantity. No explicit sort order.
Status row with a four-digit code:
- 1000: no items on the bin (regardless of pick lists and boxes)
- 1100: items found, none on pick lists, none in boxes
- 1101: items found, none on pick lists, some in boxes
- 1110: items found, some on pick lists, none in boxes
- 1111: items found, on pick lists and in boxes

Notes

The bin lookup compares BinLocID = @LocID. If LocID is omitted (NULL), no bin is found under standard NULL comparison, all result sets are empty and the status is 1000. Always pass LocID.
If the status is 1000, pick list and box rows may still have been returned; the code does not evaluate them in that case.
All reads use NOLOCK, so the data can include uncommitted changes.
The second result set repeats the requested BinName in every row.

Parameters

Parameter Type Default Description

Parameter	Type	Default	Description
`BinName` Required	varchar(50) string	–	Name of the bin to inspect. Example: `A-01-02`
`LocID`	varchar(3) string	NULL	Location ID of the bin. Effectively required, because NULL does not match any bin. Example: `001`
`GroupItems`	bit boolean	0	Controls grouping of the first result set. Allowed values `0` – One row per item and update date of the bin entry. `1` – One row per item with the latest update date. Example: `1`

BinName

Required

varchar(50)
string

–

Name of the bin to inspect.

Example: A-01-02

LocID

varchar(3)
string

NULL

Location ID of the bin. Effectively required, because NULL does not match any bin.

Example: 001

GroupItems

bit
boolean

Controls grouping of the first result set.

Allowed values

0 – One row per item and update date of the bin entry.
1 – One row per item with the latest update date.

Example: 1

Response

Result set 1 · Always (empty if the bin is not found or holds no items)

Items stored on the bin with their stock level, sorted by update date.

Column	Type	Description
`ItemKey`	int	Internal key of the item.
`EANUPC` Nullable	string	EAN/UPC of the item.
`ItemNRInt` Nullable	string	Internal item number.
`ItemNrSuppl` Nullable	string	Supplier item number.
`StockLevel` Nullable	int	Sum of the quantities on the bin (`BinItemQty`).
`UpdateDate` Nullable	datetime dateTime	Update date of the bin entry; with `GroupItems = 1` the latest one.

Result set 2 · Always (empty if no open pick list entries exist for the bin)

Items from the bin on non-expired pick lists whose order line status is not AUS, NLB, RET, STO or EIN.

Column	Type	Description
`BinName`	varchar(50) string	The requested bin name.
`ArtNr` Nullable	string	Item number from the order line.
`ItemRef` Nullable	int	Item key referenced by the order line.
`PickListNr` Nullable	int	Pick list header reference (`PLIheaderRef`).
`Sum_PickListItem`	int	Number of pick list positions for this item and pick list.

Result set 3 · Always (empty if no box contents exist for the bin)

Items from the bin that are packed in boxes (order line status EIN, pick list entry not expired).

Column	Type	Description
`ArtNr` Nullable	string	Item number from the order line.
`BoxNr` Nullable	string	Box number.
`ItemRef` Nullable	int	Item key referenced by the order line.
`sum_box_item` Nullable	int	Summed quantity of the item in the box (`ItemQty`).

Result set 4 · Always

Combined status code describing which of the previous result sets contained rows.

Column	Type	Description
`Status`	varchar(4) string	`1000` no items on bin; `1100` items only; `1101` items and boxes; `1110` items and pick lists; `1111` items, pick lists and boxes.

Response example

<SqlRowSet1>
  <row>
    <ItemKey>10452</ItemKey>
    <EANUPC>4006381333931</EANUPC>
    <ItemNRInt>ART-10452</ItemNRInt>
    <ItemNrSuppl>SUP-7781</ItemNrSuppl>
    <StockLevel>12</StockLevel>
    <UpdateDate>2024-03-11T09:15:00</UpdateDate>
  </row>
  <row>
    <ItemKey>10877</ItemKey>
    <EANUPC>4006381334112</EANUPC>
    <ItemNRInt>ART-10877</ItemNRInt>
    <ItemNrSuppl>SUP-8020</ItemNrSuppl>
    <StockLevel>4</StockLevel>
    <UpdateDate>2024-03-12T14:02:00</UpdateDate>
  </row>
</SqlRowSet1>

Examples

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:pixiGetItemsOnStockBinPickList>
      <BinName>A-01-02</BinName>
      <!-- <LocID>001</LocID> -->
      <!-- <GroupItems>1</GroupItems> -->
    </ns1:pixiGetItemsOnStockBinPickList>
  </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:pixiGetItemsOnStockBinPickList>
      <BinName>A-01-02</BinName>
      <!-- <LocID>001</LocID> -->
      <!-- <GroupItems>1</GroupItems> -->
    </ns1:pixiGetItemsOnStockBinPickList>
  </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 = [
    'BinName' => 'A-01-02',
    // 'LocID' => '001',
    // 'GroupItems' => '1',
];

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

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

Tables used

InvBin · Read InvBinItem · Read Items · Read PLitem · Read Orderlines · Read boxitems · Read boxes · Read

SQL object:: dbo.pipiGetItemsOnStockBinPickList