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

POST https://apigateway.descartes.com/tms/pixi/pixiPicklistProfilesGet

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)


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)

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)