GetPickOrdersByQuery
This function lets you query for pick orders using a filter.
Tags: GetPickOrdersByQuery, GetPickOrdersQuery, GetPickOrdersQueryPaging, GetPickOrdersByQueryResponse, GetPickOrdersResult, GetPickOrderInfo, GetPickOrderErrorResult, PickOrderGoodsOwnerInfo, GetPickOrderInfoPickOrderTypeInfo, PickOrderAssignedPickerUserInfo, PickOrderAssignedPackerUserInfo, PickOrderDateInfo
Request XML
POST /xxx/Automation.asmx HTTP/1.1
Host: api.ongoingsystems.se
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ongoingsystems.se/Automation/GetPickOrdersByQuery"
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetPickOrdersByQuery xmlns="http://ongoingsystems.se/Automation">
<UserName>string</UserName>
<Password>string</Password>
<Query>
<PickOrderIdsToGet>
<int>int</int>
<int>int</int>
</PickOrderIdsToGet>
<Paging>
<MaxPickOrdersToGet>int</MaxPickOrdersToGet>
<PickOrderIdFrom>int</PickOrderIdFrom>
</Paging>
<OnlyLiveGoodsOwners>boolean</OnlyLiveGoodsOwners>
<IsPickOrderExecuted>boolean</IsPickOrderExecuted>
<IsPickOrderPacked>boolean</IsPickOrderPacked>
<PickOrderCreatedFrom>dateTime</PickOrderCreatedFrom>
</Query>
</GetPickOrdersByQuery>
</soap:Body>
</soap:Envelope>
Request specification
| GetPickOrdersByQuery |
| UserName |
string(50) |
Req. |
Your username |
| Password |
string(50) |
Req. |
Your password |
| Query |
GetPickOrdersQuery |
Req. |
The query object |
| GetPickOrdersQuery |
| PickOrderIdsToGet |
int[] |
|
Containing elements of int, defining pick order IDs to get |
| Paging |
GetPickOrdersQueryPaging |
|
An element of type GetPickOrdersQueryPaging. |
| OnlyLiveGoodsOwners |
boolean |
|
|
| IsPickOrderExecuted |
boolean |
|
|
| IsPickOrderPacked |
boolean |
|
|
| PickOrderCreatedFrom |
dateTime |
|
|
| GetPickOrdersQueryPaging |
| MaxPickOrdersToGet |
int |
|
The maximum number of changes to get. Must be between 10 and 2000. |
| PickOrderIdFrom |
int |
|
Only get changes orders where pick order ID is equal or larger than this value. |
Response XML
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetPickOrdersByQueryResponse xmlns="http://ongoingsystems.se/Automation">
<GetPickOrdersByQueryResult>
<Success>boolean</Success>
<PickOrders>
<GetPickOrderInfo>
<PickOrderId>int</PickOrderId>
<IsExecuted>boolean</IsExecuted>
<GoodsOwner>
<GoodsOwnerId>int</GoodsOwnerId>
<GoodsOwnerName>string</GoodsOwnerName>
</GoodsOwner>
<PickOrderType>
<PickOrderTypeId>int</PickOrderTypeId>
<PickOrderTypeCode>string</PickOrderTypeCode>
<PickOrderTypeName>string</PickOrderTypeName>
</PickOrderType>
<PickOrderComment>string</PickOrderComment>
<PickOrderPriority>int</PickOrderPriority>
<AssignedPicker>
<UserId>int</UserId>
<UserName>string</UserName>
</AssignedPicker>
<AssignedPacker>
<UserId>int</UserId>
<UserName>string</UserName>
</AssignedPacker>
<DateInfo>
<Created>dateTime</Created>
<PickStarted>dateTime</PickStarted>
<PickFinished>dateTime</PickFinished>
<PackStarted>dateTime</PackStarted>
<PackFinished>dateTime</PackFinished>
</DateInfo>
</GetPickOrderInfo>
<GetPickOrderInfo>
<PickOrderId>int</PickOrderId>
<IsExecuted>boolean</IsExecuted>
<GoodsOwner>
<GoodsOwnerId>int</GoodsOwnerId>
<GoodsOwnerName>string</GoodsOwnerName>
</GoodsOwner>
<PickOrderType>
<PickOrderTypeId>int</PickOrderTypeId>
<PickOrderTypeCode>string</PickOrderTypeCode>
<PickOrderTypeName>string</PickOrderTypeName>
</PickOrderType>
<PickOrderComment>string</PickOrderComment>
<PickOrderPriority>int</PickOrderPriority>
<AssignedPicker>
<UserId>int</UserId>
<UserName>string</UserName>
</AssignedPicker>
<AssignedPacker>
<UserId>int</UserId>
<UserName>string</UserName>
</AssignedPacker>
<DateInfo>
<Created>dateTime</Created>
<PickStarted>dateTime</PickStarted>
<PickFinished>dateTime</PickFinished>
<PackStarted>dateTime</PackStarted>
<PackFinished>dateTime</PackFinished>
</DateInfo>
</GetPickOrderInfo>
</PickOrders>
<Error>
<ErrorType>Unknown or LogonError or NoFilterSpecified</ErrorType>
<Message>string</Message>
</Error>
</GetPickOrdersByQueryResult>
</GetPickOrdersByQueryResponse>
</soap:Body>
</soap:Envelope>
Response specification
| GetPickOrdersByQueryResponse |
| GetPickOrdersByQueryResult |
GetPickOrdersResult |
|
| GetPickOrdersResult |
| Success |
boolean |
|
| PickOrders |
GetPickOrderInfo[] |
Containing elements of AutomationPickOrder |
| Error |
GetPickOrderErrorResult |
An element of type GetPickOrderErrorResult. |
| GetPickOrderInfo |
| PickOrderId |
int |
|
| IsExecuted |
boolean |
|
| GoodsOwner |
PickOrderGoodsOwnerInfo |
An element of type PickOrderGoodsOwnerInfo. |
| PickOrderType |
GetPickOrderInfoPickOrderTypeInfo |
An element of type GetPickOrderInfoPickOrderTypeInfo. |
| PickOrderComment |
string |
|
| PickOrderPriority |
int |
|
| AssignedPicker |
PickOrderAssignedPickerUserInfo |
An element of type PickOrderAssignedPickerUserInfo. |
| AssignedPacker |
PickOrderAssignedPackerUserInfo |
An element of type PickOrderAssignedPackerUserInfo. |
| DateInfo |
PickOrderDateInfo |
An element of type PickOrderDateInfo. |
| GetPickOrderErrorResult |
| ErrorType |
enum |
An element of type GetPickOrdersErrorType. |
| Message |
string |
|
| PickOrderGoodsOwnerInfo |
| GoodsOwnerId |
int |
|
| GoodsOwnerName |
string |
|
| GetPickOrderInfoPickOrderTypeInfo |
| PickOrderTypeId |
int |
|
| PickOrderTypeCode |
string |
|
| PickOrderTypeName |
string |
|
| PickOrderAssignedPickerUserInfo |
| UserId |
int |
|
| UserName |
string |
|
| PickOrderAssignedPackerUserInfo |
| UserId |
int |
|
| UserName |
string |
|
| PickOrderDateInfo |
| Created |
dateTime |
|
| PickStarted |
dateTime |
|
| PickFinished |
dateTime |
|
| PackStarted |
dateTime |
|
| PackFinished |
dateTime |
|