pixiShippingGetPicklistDetails
API call to return Picklist details data.
Since pixi version: LOU Official (6.3.0.4452) Additional notes:
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
PicklistKey | integer | false | Picklist Id Type: int Default value: NULL Example: 123 Available from: LOU Official (6.3.0.4452) |
FilterBinName | string | false | Bin Name Type: varchar(50) Default value: NULL Example: abcdef Available from: LOU Official (6.3.0.4452) |
FilterBinGroup | string | false | Bin Group Name Type: varchar(20) Default value: NULL Example: abcdef Available from: LOU Official (6.3.0.4452) |
FilterLocation | string | false | Location Id Type: varchar(3) Default value: NULL Example: 001 Available from: LOU Official (6.3.0.4452) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiShippingGetPicklistDetails>
<PicklistKey>0</PicklistKey>
<FilterLocation>string</FilterLocation>
<FilterBinGroup>string</FilterBinGroup>
<FilterBinName>string</FilterBinName>
</pixiShippingGetPicklistDetails>
</Body>
</Envelope>
Response
1. Picklist detail data
Name | Type | Description |
---|---|---|
Qty | integer | quantity of this item to take from bin Type: int Available from: 25.06 (25.6.0.58802) |
BinKey | integer | pixi* bin key Type: int Available from: 25.06 (25.6.0.58802) |
BinRef | integer | pixi* bin key Type: int Available from: 25.06 (25.6.0.58802) |
EanUpc | string | default barcode Type: varchar Available from: 25.06 (25.6.0.58802) |
BinName | string | bin name Type: varchar Available from: 25.06 (25.6.0.58802) |
CustKey | integer | Customer Id Type: int Available from: 25.06 (25.6.0.58802) |
OrderNr | integer | Order Number Type: int Available from: 25.06 (25.6.0.58802) |
BinGroup | string | bin group Type: varchar Available from: 25.06 (25.6.0.58802) |
ItemName | string | item name Type: varchar Available from: 25.06 (25.6.0.58802) |
Location | string | location where to take the item Type: varchar Available from: 25.06 (25.6.0.58802) |
PLHtoBox | integer | box range end Type: int Available from: 25.06 (25.6.0.58802) |
ItemNrInt | string | Shop Item Nr Type: varchar Available from: 25.06 (25.6.0.58802) |
BinItemRef | integer | pixi* item key Type: int Available from: 25.06 (25.6.0.58802) |
BinSortNum | integer | sort number of the bin Type: int Available from: 25.06 (25.6.0.58802) |
PLHfromBox | integer | box range start Type: int Available from: 25.06 (25.6.0.58802) |
ItemNrSuppl | string | Item Nr Supplier Type: varchar Available from: 25.06 (25.6.0.58802) |
PLIheaderRef | integer | picklist header Type: int Available from: 25.06 (25.6.0.58802) |
PicLinkLarge | string | large item image url Type: varchar Available from: 25.06 (25.6.0.58802) |
PicLinkSmall | string | small item image url Type: varchar Available from: 25.06 (25.6.0.58802) |
BundleItemName | string | Item Name (bundle) Type: varchar Available from: 25.06 (25.6.0.58802) |
ItemNrExternal | string | External Order Number Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderNrExternal | string | External Order Number Type: varchar Available from: 25.06 (25.6.0.58802) |
OtherItemsCount | integer | Other Items Count Type: int Available from: 25.06 (25.6.0.58802) |
PLIorderlineRef | integer | orderline for this picklist entry Type: int Available from: 25.06 (25.6.0.58802) |
PicklistComment | string | picklist comment Type: varchar Available from: 25.06 (25.6.0.58802) |
TotalItemsOnBin | integer | Number of Items on Bin Type: int Available from: 25.06 (25.6.0.58802) |
PLIorderlineRef_1 | integer | PLIorderlineRef_1 Type: int Available from: 25.06 (25.6.0.58802) |
BundleOrderlineRef | integer | Bundle orderline Id Type: int Available from: 25.06 (25.6.0.58802) |
PicklistCreateDate | string | create date of this picklist Type: datetime Available from: 25.06 (25.6.0.58802) |
PicklistExpiryDate | string | expiry date of the picklist Type: datetime Available from: 25.06 (25.6.0.58802) |
TotalSimilarItemsOnBin | integer | Number of similar Items on Bin Type: int Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiShippingGetPicklistDetailsPost200TextXmlResponse>
<BinItemRef>0</BinItemRef>
<PLIheaderRef>0</PLIheaderRef>
<BinSortNum>0</BinSortNum>
<ItemName>string</ItemName>
<BinName>string</BinName>
<BinKey>0</BinKey>
<PicklistExpiryDate>string</PicklistExpiryDate>
<PicklistCreateDate>string</PicklistCreateDate>
<Qty>0</Qty>
<PicklistComment>string</PicklistComment>
<ItemNrSuppl>string</ItemNrSuppl>
<EanUpc>string</EanUpc>
<ItemNrInt>string</ItemNrInt>
<BinRef>0</BinRef>
<BinGroup>string</BinGroup>
<PLIorderlineRef>0</PLIorderlineRef>
<Location>string</Location>
<PicLinkSmall>string</PicLinkSmall>
<PicLinkLarge>string</PicLinkLarge>
<OrderNr>0</OrderNr>
<OrderNrExternal>string</OrderNrExternal>
<ItemNrExternal>string</ItemNrExternal>
<BundleOrderlineRef>0</BundleOrderlineRef>
<CustKey>0</CustKey>
<OtherItemsCount>0</OtherItemsCount>
<PLHfromBox>0</PLHfromBox>
<PLHtoBox>0</PLHtoBox>
<PLIorderlineRef_1>0</PLIorderlineRef_1>
<BundleItemName>string</BundleItemName>
<TotalItemsOnBin>0</TotalItemsOnBin>
<TotalSimilarItemsOnBin>0</TotalSimilarItemsOnBin>
</PixiShippingGetPicklistDetailsPost200TextXmlResponse>
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:pixiShippingGetPicklistDetails>
<PicklistKey xsi:type="xsd:integer">123</PicklistKey>
<FilterBinName xsi:type="xsd:string">abcdef</FilterBinName>
<FilterBinGroup xsi:type="xsd:string">abcdef</FilterBinGroup>
<FilterLocation xsi:type="xsd:string">001</FilterLocation>
</ns1:pixiShippingGetPicklistDetails>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiShippingGetPicklistDetails', [
'PicklistKey' => '123', // integer
'FilterBinName' => 'abcdef', // string
'FilterBinGroup' => 'abcdef', // string
'FilterLocation' => '001', // string
]);
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);
}