pixiPicklistProfilesGet
API call returns picklist profiles
Since pixi version: 21.01 (9.0.23.54983) Additional notes:
API call returns all picklist profiles when no filter parameter is specified.
Sample ProfileParameterValues XML output
<pixiPickList>
<LocID>001</LocID>
<LimitNumberOfOrders>999</LimitNumberOfOrders>
<OrderNrOnly>123</OrderNrOnly>
<ExtOrderNrOnly />
<LimitItemsQTY>0</LimitItemsQTY>
<ConfigType />
<CountryInclude />
<CountryExclude />
<PaymentList>B,K,L,M,N,R,P,C</PaymentList>
<PartialOrder>false</PartialOrder>
<OlderThan>0</OlderThan>
<OlderThanHour>0</OlderThanHour>
<OlderThanMinute>0</OlderThanMinute>
<SortBy>BINSORTNUM</SortBy>
<PartialQtys>false</PartialQtys>
<OrderNumbers />
<OrderlineRefs />
<ConsiderAllLocStock>false</ConsiderAllLocStock>
<IncludeShipVendors>DHL,D2M,DPD,ENV,FDX,GLS,OPK,SEL,SCL,SIT,SWP,UPS,UPE,VLG,VL2</IncludeShipVendors>
<IncludeShipLocked>false</IncludeShipLocked>
<FromBoxNr>0</FromBoxNr>
<ToBoxNr>0</ToBoxNr>
<ONLY_express>0</ONLY_express>
<ONLY_noExpress>0</ONLY_noExpress>
<ShipDate>0</ShipDate>
<NewerThan>0</NewerThan>
<NewerThanHour>0</NewerThanHour>
<NewerThanMinute>0</NewerThanMinute>
<ShopList>ADV,FWD,GEN,LEO,NEW,QA,XTC,ZEB</ShopList>
<QtyHigherThan>0</QtyHigherThan>
<ExcludeConfigType />
<ANGdateFilterEnabled>false</ANGdateFilterEnabled>
<IsBinSortNumEnabled>false</IsBinSortNumEnabled>
<IsCountryGroupEnabled>false</IsCountryGroupEnabled>
<OneScanPicklist>false</OneScanPicklist>
<ANGdateFrom>0</ANGdateFrom>
<ANGdateTo>0</ANGdateTo>
<FromBinSortNum>0</FromBinSortNum>
<ToBinSortNum>0</ToBinSortNum>
<PLcomment>Comment 123</PLcomment>
<OnlyForUsedBoxes>0</OnlyForUsedBoxes>
<FromWeight>0</FromWeight>
<ToWeight>0</ToWeight>
<FromVolume>0</FromVolume>
<ToVolume>0</ToVolume>
<CountryGroup />
<MinValueOfNotAvailable>0</MinValueOfNotAvailable>
<MinValueOfAvailable>0</MinValueOfAvailable>
<Exclude1SSorders>false</Exclude1SSorders>
<TagsOR>-3</TagsOR>
<TagsAND />
<TagsNOT />
<IncludeBinGroups />
<DaysBeforeBBD>0</DaysBeforeBBD>
<IsDaysBeforeBbdEnabled>true</IsDaysBeforeBbdEnabled>
<AllItemsWithSelectedTags>true</AllItemsWithSelectedTags>
<MinNumberOfOrders>0</MinNumberOfOrders>
<NumberOfPicklistsToCreate>1</NumberOfPicklistsToCreate>
<IsNewerThanEnabled>false</IsNewerThanEnabled>
<IsOlderThanEnabled>false</IsOlderThanEnabled>
<IsMinValueOfNotAvailableEnabled>false</IsMinValueOfNotAvailableEnabled>
<IsMinValueOfAvailableEnabled>false</IsMinValueOfAvailableEnabled>
<SOrderNr>0</SOrderNr>
<FromBin />
<ToBin />
<OrderTagsOR>-8,-9,-10,-11</OrderTagsOR>
<OrderTagsAND />
<OrderTagsNOT />
<HighVolume1SSItemKey>0</HighVolume1SSItemKey>
<IsHighVolumeSplitByItems>0</IsHighVolumeSplitByItems>
<BoxPhysicallyFull>false</BoxPhysicallyFull>
<DisablePicklistSplitOnBatchManagement>false</DisablePicklistSplitOnBatchManagement>
</pixiPickList>
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
1SS | boolean | false | Return only 1SS picklist profiles Type: bit Default value: 0 Example: 0 or 1 Available from: 21.01 (9.0.23.54983) |
ProfileId | integer | false | Picklist profile Id Type: int Default value: NULL Example: 123 Available from: 21.01 (9.0.23.54983) |
ProfileName | string | false | Picklist profile name Type: varchar(500) Default value: Example: abcdefg Available from: 21.01 (9.0.23.54983) |
UpdatedAfter | string | false | Picklist create or update date (start of time range) Type: datetime Default value: NULL Example: YYYY-MM-DD hh:mm:ss Available from: 21.01 (9.0.23.54983) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiPicklistProfilesGet>
<ProfileId>0</ProfileId>
<ProfileName>string</ProfileName>
<UpdatedAfter>string</UpdatedAfter>
<_x0031_SS>true</_x0031_SS>
</pixiPicklistProfilesGet>
</Body>
</Envelope>
Response
Name | Type | Description |
---|---|---|
CreateEmp | string | Creator of the record Type: varchar Available from: 25.06 (25.6.0.58802) |
ProfileId | integer | Picklist profile Id Type: int Available from: 25.06 (25.6.0.58802) |
UpdateEmp | string | User who last updated the record Type: varchar Available from: 25.06 (25.6.0.58802) |
CreateDate | string | Create date Type: datetime Available from: 25.06 (25.6.0.58802) |
UpdateDate | string | Last update date of the record Type: datetime Available from: 25.06 (25.6.0.58802) |
ProfileName | string | Picklist profile name Type: varchar Available from: 25.06 (25.6.0.58802) |
ProfileFor1SS | boolean | Indicator of 1SS picklist profile Type: bit Available from: 25.06 (25.6.0.58802) |
ProfileDescription | string | Picklist profile description Type: varchar Available from: 25.06 (25.6.0.58802) |
ProfileParameterValues | string | Picklist profile parameter values (see additional notes) Type: xml Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiPicklistProfilesGetPost200TextXmlResponse>
<ProfileId>0</ProfileId>
<ProfileName>string</ProfileName>
<ProfileDescription>string</ProfileDescription>
<ProfileFor1SS>true</ProfileFor1SS>
<CreateEmp>string</CreateEmp>
<CreateDate>string</CreateDate>
<UpdateEmp>string</UpdateEmp>
<UpdateDate>string</UpdateDate>
<ProfileParameterValues>string</ProfileParameterValues>
</PixiPicklistProfilesGetPost200TextXmlResponse>
2. Status output
Name | Type | Description |
---|---|---|
Status | string | Execution status (INFO/ERROR) Type: varchar Available from: 25.06 (25.6.0.58802) |
Message | string | Description of the status Type: varchar Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiPicklistProfilesGetPost200TextXmlResponse>
<ProfileId>0</ProfileId>
<ProfileName>string</ProfileName>
<ProfileDescription>string</ProfileDescription>
<ProfileFor1SS>true</ProfileFor1SS>
<CreateEmp>string</CreateEmp>
<CreateDate>string</CreateDate>
<UpdateEmp>string</UpdateEmp>
<UpdateDate>string</UpdateDate>
<ProfileParameterValues>string</ProfileParameterValues>
</PixiPicklistProfilesGetPost200TextXmlResponse>
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:pixiPicklistProfilesGet>
<1SS xsi:type="xsd:boolean">0 or 1</1SS>
<ProfileId xsi:type="xsd:integer">123</ProfileId>
<ProfileName xsi:type="xsd:string">abcdefg</ProfileName>
<UpdatedAfter xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</UpdatedAfter>
</ns1:pixiPicklistProfilesGet>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiPicklistProfilesGet', [
'1SS' => '0 or 1', // boolean
'ProfileId' => '123', // integer
'ProfileName' => 'abcdefg', // string
'UpdatedAfter' => 'YYYY-MM-DD hh:mm:ss', // 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);
}