pixiShippingGetPicklistHeaders
API call to return Picklist header data.
Since pixi version: LOU Official (6.3.0.4452) Additional notes:
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
LocID | string | false | Search for items on picklist for given location. 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="">
<pixiShippingGetPicklistHeaders>
<LocID>string</LocID>
</pixiShippingGetPicklistHeaders>
</Body>
</Envelope>
Response
1. Picklist data
Name | Type | Description |
---|---|---|
1SS | boolean | is 1SS picklist Type: bit Available from: 25.06 (25.6.0.58802) |
PLHkey | integer | picklist header key (for use with pixiShippinggetPicklistDetails) Type: int Available from: 25.06 (25.6.0.58802) |
HALcount | integer | HALcount Type: int Available from: 25.06 (25.6.0.58802) |
PLHlocID | string | Location of this picklist 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) |
PLExecLog | string | picklist log Type: varchar Available from: 25.06 (25.6.0.58802) |
PLcomment | string | picklist comment Type: varchar Available from: 25.06 (25.6.0.58802) |
ToBinName | string | update user (if anyone updated it) Type: varchar Available from: 25.06 (25.6.0.58802) |
createEmp | string | creator (pixi* user) Type: varchar Available from: 25.06 (25.6.0.58802) |
updateEmp | string | update user (if anyone updated it) Type: varchar Available from: 25.06 (25.6.0.58802) |
PLHfromBox | integer | box range start Type: int Available from: 25.06 (25.6.0.58802) |
createDate | string | create date Type: datetime Available from: 25.06 (25.6.0.58802) |
updateDate | string | update date Type: datetime Available from: 25.06 (25.6.0.58802) |
FromBinName | string | update user (if anyone updated it) Type: varchar Available from: 25.06 (25.6.0.58802) |
Item number | integer | Item number Type: int Available from: 25.06 (25.6.0.58802) |
PLHexpiryDate | string | expiry date Type: datetime Available from: 25.06 (25.6.0.58802) |
PLHOriginalKey | integer | picklist header key (original) Type: int Available from: 25.06 (25.6.0.58802) |
ReservedOrderNr | string | ReservedOrderNr Type: varchar Available from: 25.06 (25.6.0.58802) |
IsReservationFull | boolean | IsReservationFull Type: bit Available from: 25.06 (25.6.0.58802) |
PLexecLogAdvanced | string | picklist advanced log Type: varchar Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiShippingGetPicklistHeadersPost200TextXmlResponse>
<PLHkey>0</PLHkey>
<PLHlocID>string</PLHlocID>
<PLHexpiryDate>string</PLHexpiryDate>
<createEmp>string</createEmp>
<createDate>string</createDate>
<updateEmp>string</updateEmp>
<updateDate>string</updateDate>
<PLHfromBox>0</PLHfromBox>
<PLHtoBox>0</PLHtoBox>
<ReservedOrderNr>string</ReservedOrderNr>
<IsReservationFull>true</IsReservationFull>
<PLcomment>string</PLcomment>
<_x0031_SS>true</_x0031_SS>
<PLExecLog>string</PLExecLog>
<PLexecLogAdvanced>string</PLexecLogAdvanced>
<PLHOriginalKey>0</PLHOriginalKey>
<FromBinName>string</FromBinName>
<ToBinName>string</ToBinName>
<HALcount>0</HALcount>
<Item_x0020_number>0</Item_x0020_number>
</PixiShippingGetPicklistHeadersPost200TextXmlResponse>
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:pixiShippingGetPicklistHeaders>
<LocID xsi:type="xsd:string">001</LocID>
</ns1:pixiShippingGetPicklistHeaders>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiShippingGetPicklistHeaders', [
'LocID' => '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);
}