Description
It can be used to create a picklist and can only be used when the database setting "Premium API"
Request Parameters
| # |
Name |
Type |
Required |
Example |
Description |
| 1 |
ProfileId |
string |
0 |
123 |
ProfileId for which picklist will be created. |
| 2 |
LocationId |
string |
0 |
002 |
Location on which picklist will be created. |
| 3 |
OrderNr |
integer |
0 |
123 |
Create picklist for a specific order |
| 4 |
BinFrom |
string |
0 |
A-00-01 |
Consider bins equal and higher that specified when gathering items |
| 5 |
BinTo |
string |
0 |
A-00-99 |
Consider bins equal and lower that specified when gathering items |
| 6 |
UserName |
string |
0 |
abcdefg |
User starting the picklist creation |
| 7 |
Comment |
string |
0 |
abcdefg |
Comment added to the picklist creation method |
| 8 |
ExecuteAsynchronous |
boolean |
0 |
0 or 1 |
Create picklist in the background or wait till the picklist is created |
| 9 |
OrderNrExternal |
string |
0 |
abcdefg |
Create picklist for a specific external order number |
Request body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dem="https://api.pixi.eu/soap/demosandbox/">
<soapenv:Header/>
<soapenv:Body>
<dem:pixiCreatePicklist>
<dem:ProfileId>123</dem:ProfileId>
<dem:LocationId>002</dem:LocationId>
<dem:OrderNr>123</dem:OrderNr>
<dem:BinFrom>A-00-01</dem:BinFrom>
<dem:BinTo>A-00-99</dem:BinTo>
<dem:UserName>abcdefg</dem:UserName>
<dem:Comment>abcdefg</dem:Comment>
<dem:ExecuteAsynchronous>0 or 1</dem:ExecuteAsynchronous>
<dem:OrderNrExternal>abcdefg</dem:OrderNrExternal>
</dem:pixiCreatePicklist>
</soapenv:Body>
</soapenv:Envelope>
Response
Body 1: Status and Log output
| # |
Name |
Type |
Description |
| 1 |
PLHKEY |
integer |
Picklist Id |
| 2 |
PLexecLog |
string |
Picklist Log |
| 3 |
PLexecLogAdvanced |
string |
Advanced (detailed) Picklist Log |
| 4 |
ErrorMessage |
string |
Error description |
| 5 |
ItemsOnPicklist |
integer |
Count of items on this Picklist |
| 6 |
PicklistKeyList |
string |
CSV list of created Picklist(s) |
Body 2: Status output
| # |
Name |
Type |
Description |
| 1 |
Status |
string |
Execution status (INFO/ERROR) |
| 2 |
Message |
string |
Description of the status |
Additional Notes
The API call can only be used when "**Premium API**" setting is enabled.
By default picklists are executed **asynchronously** in 1 minute intervals.
When executing the API in this mode user needs to wait/read the pixiEXPicklistCreated message before starting a new picklist creation, to prevent parallel picklist creation error.
If the value for parameter **ExecuteAsynchronous** is set to 0 then the API call waits till the picklist creation is done?.
With parameter **ProfileId** user selects the picklist profile that will be used for creation of the picklist. If no profile is selected the default picklist profile will be taken.
The values of the picklist profile can be than additionally updated by parameters:
- LocationId
- OrderNr
- BinFrom
- BinTo
- UserName
- Comment
When picklist is created a message is sent out to exchange pixiEXPicklistCreated.
If an empty picklist is created, the message is sent, but picklist is not seen in the client because it is empty.
In case created picklist is split into several picklist because of BatchManagement then we send out several messages - one for each created picklists.
Body of the message:?
{"data":[{"PicklistHeaderId":1891,"LocationId":"001","FromBox":0,"ToBox":0,"OneScanShipping":0,"DaysBeforeBestBeforeDate":0,"Comment":"test picklist"}]}?
