Shipping Read

pixiShippingGetPicklistHeaders

Returns the headers of all valid, unreserved and fully executed picklists of a location, with first/last bin and item count.

Returns one row per picklist header from PLHeader that is currently usable for picking.

Filter

PLHlocID equals @LocID. If LocID is empty or omitted, location 001 is used.
PLHexpiryDate is later than the current date/time (picklist not expired).
ReservedOrderNr is NULL or 0 (picklist is not reserved for an order).
PLcomment is not DirectInvStockRelease.
ExecutionFinished = 1 (picklist generation has finished).

Calculated columns

FromBinName / ToBinName: name of the Lagerplatz with the lowest / highest BinSortNum among the bins referenced by the picklist items (PLitem.pliBinRef). Empty string if the picklist has no items.
HALcount: number of Orderlines of ReservedOrderNr with status HAL.
Item number: number of distinct item/bin combinations on the picklist (items are counted once per Lagerplatz). 0 if the picklist has no items.
ReservedOrderNr, IsReservationFull and PLHOriginalKey are returned as 0 / false instead of NULL.

The result has no explicit sort order.

Notes

All tables are read with NOLOCK; uncommitted data may appear.
Because only unreserved picklists are returned (ReservedOrderNr is NULL/0), HALcount is in practice always 0 (it would only count lines of an order with number 0).
Picklists with PLcomment = NULL are excluded as well, because the comparison <> 'DirectInvStockRelease' is not true for NULL.
The column Item number contains a space; in the .NET DataSet XML of the SOAP response it typically appears as element Item_x0020_number.
Only items whose InvBinItem and Items records exist are counted in Item number; FromBinName/ToBinName only consider items whose bin exists in InvBin.

Tables used

PLHeader · Read PLitem · Read InvBin · Read InvBinItem · Read Items · Read Orderlines · Read

Parameter	Type	Default	Description
`LocID`	varchar(3) string	NULL	Location (Lager) ID whose picklists are returned. Empty or omitted means `001`. Example: `001`

Result set 1 · Always (may be empty)

One row per valid, unreserved and fully executed picklist of the location.

Column	Type	Description
`PLHkey`	int	Key of the picklist header.
`PLHlocID`	varchar(3) string	Location ID of the picklist.
`PLHexpiryDate`	datetime dateTime	Expiry date/time of the picklist (always in the future).
`createEmp` Nullable	string	Employee who created the picklist.
`createDate` Nullable	datetime dateTime	Creation date of the picklist.
`updateEmp` Nullable	string	Employee who last changed the picklist.
`updateDate` Nullable	datetime dateTime	Date of the last change.
`PLHfromBox` Nullable	string	Start box of the picklist as stored in the header.
`PLHtoBox` Nullable	string	End box of the picklist as stored in the header.
`ReservedOrderNr`	int	Order number the picklist is reserved for; always `0` in this result.
`IsReservationFull`	bit boolean	Reservation-full flag; `false` if not set.
`PLcomment`	string	Comment of the picklist.
`1SS` Nullable	string	Value of column `1SS` of the picklist header.
`PLExecLog` Nullable	string	Execution log of the picklist generation.
`PLexecLogAdvanced` Nullable	string	Advanced execution log of the picklist generation.
`PLHOriginalKey`	int	Key of the original picklist; `0` if not set.
`DaysBeforeBBD` Nullable	int	Days before best-before date used for the picklist.
`FromBinName`	string	Name of the first bin (lowest `BinSortNum`) on the picklist; empty if none.
`ToBinName`	string	Name of the last bin (highest `BinSortNum`) on the picklist; empty if none.
`HALcount`	int	Number of order lines of `ReservedOrderNr` with status `HAL`.
`Item number`	int	Number of distinct item/bin combinations on the picklist.

Response example

<SqlRowSet1>
  <row>
    <PLHkey>4711</PLHkey>
    <PLHlocID>001</PLHlocID>
    <PLHexpiryDate>2024-05-14T18:00:00</PLHexpiryDate>
    <createEmp>MM</createEmp>
    <createDate>2024-05-14T08:12:30</createDate>
    <updateEmp>MM</updateEmp>
    <updateDate>2024-05-14T08:13:05</updateDate>
    <PLHfromBox>1</PLHfromBox>
    <PLHtoBox>20</PLHtoBox>
    <ReservedOrderNr>0</ReservedOrderNr>
    <IsReservationFull>false</IsReservationFull>
    <PLcomment>Morning wave</PLcomment>
    <PLHOriginalKey>0</PLHOriginalKey>
    <DaysBeforeBBD>0</DaysBeforeBBD>
    <FromBinName>A-01-01</FromBinName>
    <ToBinName>C-12-04</ToBinName>
    <HALcount>0</HALcount>
    <Item_x0020_number>37</Item_x0020_number>
  </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:pixiShippingGetPicklistHeaders>
      <!-- <LocID>001</LocID> -->
    </ns1:pixiShippingGetPicklistHeaders>
  </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:pixiShippingGetPicklistHeaders>
      <!-- <LocID>001</LocID> -->
    </ns1:pixiShippingGetPicklistHeaders>
  </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 = [
    // 'LocID' => '001',
];

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

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

SQL object:: dbo.pipiShippingGetPicklistHeaders