pixiGetPickListDetailForPico
Enabled but undocumented
Returns picklist items for the specified picklist, including split picklist items, for pico/mobile picking.
Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes: Wraps dbo.Pixi_GetPickListDetailForPico, always using its default behaviour (no picking status filter, split picklist items included). Uses the PickListNumberColumn setting to determine item number display format. Returns data aggregated by bin location with batch and best-before-date tracking.
Request
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| PLHkey | integer | true | Picklist Id Type: int Default value: Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiGetPickListDetailForPico>
<PLHkey>0</PLHkey>
</pixiGetPickListDetailForPico>
</Body>
</Envelope>
Response
1. Result set
| Name | Type | Description |
|---|---|---|
| Qty | integer | Quantity to pick from this bin Type: INT Available from: / (26.9.0.14135) |
| BinKey | integer | Bin location key Type: INT Available from: / (26.9.0.14135) |
| EanUpc | string | EAN/UPC barcode Type: VARCHAR Available from: / (26.9.0.14135) |
| BinName | string | Bin location name Type: VARCHAR Available from: / (26.9.0.14135) |
| OrderNr | integer | Internal (pixi) order number Type: INT Available from: / (26.9.0.14135) |
| BinGroup | string | Bin group identifier Type: VARCHAR Available from: / (26.9.0.14135) |
| ItemName | string | Item name with number prefix (format based on PickListNumberColumn setting) Type: VARCHAR Available from: / (26.9.0.14135) |
| ItemTags | string | Comma-separated list of item tags Type: VARCHAR Available from: / (26.9.0.14135) |
| PLHtoBox | integer | Ending box number Type: INT Available from: / (26.9.0.14135) |
| ItemNrInt | string | Supplier item number, returned as ItemNrInt for backward compatibility Type: VARCHAR Available from: / (26.9.0.14135) |
| OrderUnit | integer | Raw packing unit from dbo.items.OrderUnit, appended last for backward compatibility; NULL when not set or not numeric Type: INT Available from: / (26.9.0.14135) |
| PLcomment | string | Picklist comment Type: VARCHAR Available from: / (26.9.0.14135) |
| createEmp | string | Employee who created the picklist Type: VARCHAR Available from: / (26.9.0.14135) |
| pliBinRef | integer | Picklist item bin reference Type: INT Available from: / (26.9.0.14135) |
| BinItemRef | integer | Item reference in bin inventory Type: INT Available from: / (26.9.0.14135) |
| BinSortNum | integer | Bin sorting number for picking order Type: INT Available from: / (26.9.0.14135) |
| ItemNrInt1 | string | Internal item number, returned as ItemNrInt1 Type: VARCHAR Available from: / (26.9.0.14135) |
| PLHfromBox | integer | Starting box number Type: INT Available from: / (26.9.0.14135) |
| BatchNumber | string | Batch number for batch management Type: VARCHAR Available from: / (26.9.0.14135) |
| DistinctBins | integer | Total number of distinct bins in the picklist Type: INT Available from: / (26.9.0.14135) |
| Manufacturer | string | Manufacturer/artist name Type: VARCHAR Available from: / (26.9.0.14135) |
| MinPlItemKey | integer | Minimum picklist item key Type: INT Available from: / (26.9.0.14135) |
| PLIheaderRef | integer | Picklist header key Type: INT Available from: / (26.9.0.14135) |
| PicLinkLarge | string | URL to large product image Type: VARCHAR Available from: / (26.9.0.14135) |
| PicLinkSmall | string | URL to small product image Type: VARCHAR Available from: / (26.9.0.14135) |
| PLHexpiryDate | string | Picklist expiry date Type: DATETIME Available from: / (26.9.0.14135) |
| BestBeforeDate | string | Best before date Type: DATETIME Available from: / (26.9.0.14135) |
| PLHOriginalKey | integer | Original picklist key for split picklists Type: INT Available from: / (26.9.0.14135) |
| OrderNrExternal | string | External order number Type: VARCHAR Available from: / (26.9.0.14135) |
| OtherItemsCount | integer | Count of other items in the same bin Type: INT Available from: / (26.9.0.14135) |
| PLIorderlineRef | integer | Order line reference Type: INT Available from: / (26.9.0.14135) |
| HeaderCreateDate | string | Picklist creation timestamp Type: DATETIME Available from: / (26.9.0.14135) |
| PickingStatusCode | string | Picking status code Type: VARCHAR Available from: / (26.9.0.14135) |
| BestBeforeDate_Text | string | Best before date formatted as DD.MM.YYYY Type: VARCHAR Available from: / (26.9.0.14135) |
| ItemNameWithoutNumber | string | Item name without item number prefix Type: VARCHAR Available from: / (26.9.0.14135) |
Response Example
<PixiGetPickListDetailForPicoPost200TextXmlResponse>
<BinItemRef>0</BinItemRef>
<PLIheaderRef>0</PLIheaderRef>
<BinSortNum>0</BinSortNum>
<ItemNameWithoutNumber>string</ItemNameWithoutNumber>
<BinName>string</BinName>
<BinKey>0</BinKey>
<PLHexpiryDate>string</PLHexpiryDate>
<HeaderCreateDate>string</HeaderCreateDate>
<createEmp>string</createEmp>
<Qty>0</Qty>
<PLcomment>string</PLcomment>
<ItemName>string</ItemName>
<ItemNrInt>string</ItemNrInt>
<EanUpc>string</EanUpc>
<ItemNrInt1>string</ItemNrInt1>
<pliBinRef>0</pliBinRef>
<BinGroup>string</BinGroup>
<PLIorderlineRef>0</PLIorderlineRef>
<PLHfromBox>0</PLHfromBox>
<PLHtoBox>0</PLHtoBox>
<PicLinkLarge>string</PicLinkLarge>
<PicLinkSmall>string</PicLinkSmall>
<BatchNumber>string</BatchNumber>
<BestBeforeDate_Text>string</BestBeforeDate_Text>
<BestBeforeDate>string</BestBeforeDate>
<OrderNr>0</OrderNr>
<OrderNrExternal>string</OrderNrExternal>
<OtherItemsCount>0</OtherItemsCount>
<DistinctBins>0</DistinctBins>
<ItemTags>string</ItemTags>
<PickingStatusCode>string</PickingStatusCode>
<Manufacturer>string</Manufacturer>
<MinPlItemKey>0</MinPlItemKey>
<PLHOriginalKey>0</PLHOriginalKey>
<OrderUnit>0</OrderUnit>
</PixiGetPickListDetailForPicoPost200TextXmlResponse>
HTTP Example
POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
# echo -n '{{username}}:{{password}}' | base64 | pbcopy
Authorization: Basic {{token}}
<?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/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<SOAP-ENV:Body>
<ns1:pixiGetPickListDetailForPico>
<PLHkey xsi:type="xsd:integer"></PLHkey> <!-- required -->
</ns1:pixiGetPickListDetailForPico>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiGetPickListDetailForPico', [
'PLHkey' => '', // integer (required)
]);
function getPixiSoapClientResponse(string $method, array $arguments = [])
{
$soapArguments = [];
foreach ($arguments as $key => $value) {
$soapArguments[] = new SoapVar($value, null, '', '', $key);
}
$soapClient = new SoapClient(null, [
'login' => '...',
'password' => '...',
'uri' => 'https://apigateway.descartes.com/tms/pixi/',
'location' => 'https://apigateway.descartes.com/tms/pixi/',
]);
return $soapClient->__call($method, $soapArguments);
}