GetOrdersPickabilityByQuery
This function allows you find out whether or not an order is pickable given the current items in stock. Click here for more information about pickability.
Tags: GetOrdersPickabilityByQuery, GetOrdersPickabilityQuery, GetOrdersPickabilityQueryPaging, GetOrdersPickabilityByQueryResponse, GetOrdersPickabilityResult, OrderPickabilityResult, GetOrderPickabilityErrorResult, OrderPickabilityOrderInfo, OrderPickabilityInfo, OrderPickabilityOrderLineInfo, OrderPickabilityOrderStatusInfo, OrderPickabilityOrderExpectedPickable, OrderPickabilityArticle, OrderLinePickabilityInfo, OrderPickabilityParentOrderLineInfo, OrderPickabilityOrderLineExpectedPickable
Request XML
POST /xxx/Service.asmx HTTP/1.1
Host: api.ongoingsystems.se
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ongoingsystems.se/WSI/GetOrdersPickabilityByQuery"
<?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>
<GetOrdersPickabilityByQuery xmlns="http://ongoingsystems.se/WSI">
<GoodsOwnerCode>string</GoodsOwnerCode>
<UserName>string</UserName>
<Password>string</Password>
<Query>
<OrderNumbersToGet>
<string>string</string>
<string>string</string>
</OrderNumbersToGet>
<OrderIdsToGet>
<int>int</int>
<int>int</int>
</OrderIdsToGet>
<GoodsOwnerOrderIdsToGet>
<string>string</string>
<string>string</string>
</GoodsOwnerOrderIdsToGet>
<OnlyBookedOrders>boolean</OnlyBookedOrders>
<Paging>
<MaxOrdersToGet>int</MaxOrdersToGet>
<OrderIdFrom>int</OrderIdFrom>
</Paging>
</Query>
</GetOrdersPickabilityByQuery>
</soap:Body>
</soap:Envelope>
Request specification
| GetOrdersPickabilityByQuery |
| GoodsOwnerCode |
string(400) |
Req. |
The name/code of your client |
| UserName |
string(50) |
Req. |
Your username |
| Password |
string(50) |
Req. |
Your password |
| Query |
GetOrdersPickabilityQuery |
Req. |
The query object |
| GetOrdersPickabilityQuery |
| OrderNumbersToGet |
string[] |
|
Containing elements of string, defining order numbers to get |
| OrderIdsToGet |
int[] |
|
Containing elements of int, defining order IDs to get |
| GoodsOwnerOrderIdsToGet |
string[] |
|
Containing elements of string, defining goods owner order IDs to get |
| OnlyBookedOrders |
boolean |
|
|
| Paging |
GetOrdersPickabilityQueryPaging |
|
An element of type GetOrdersPickabilityQueryPaging. |
| GetOrdersPickabilityQueryPaging |
| MaxOrdersToGet |
int |
|
The maximum number of changes to get. Must be between 10 and 2000. |
| OrderIdFrom |
int |
|
Only get changes orders where orderId 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>
<GetOrdersPickabilityByQueryResponse xmlns="http://ongoingsystems.se/WSI">
<GetOrdersPickabilityByQueryResult>
<Success>boolean</Success>
<OrderPickabilityResults>
<OrderPickabilityResult>
<OrderInfo>
<OrderId>int</OrderId>
<GoodsOwnerOrderNumber>string</GoodsOwnerOrderNumber>
<GoodsOwnerOrderId>string</GoodsOwnerOrderId>
<OrderStatus>
<OrderStatusNumber>int</OrderStatusNumber>
<OrderStatusText>string</OrderStatusText>
</OrderStatus>
</OrderInfo>
<OrderPickability>
<Pickability>Ok or ByPriority or NotByPriority or NotOk or NothingToAllocate</Pickability>
<PickabilityWithMove>Ok or ByPriority or NotByPriority or NotOk or NothingToAllocate</PickabilityWithMove>
<PickabilityFromPickingLocations>Ok or ByPriority or NotByPriority or NotOk or NothingToAllocate</PickabilityFromPickingLocations>
<ExpectedPickable>
<ExpectedInDate>dateTime</ExpectedInDate>
<IsPickableByAdvised>boolean</IsPickableByAdvised>
</ExpectedPickable>
</OrderPickability>
<OrderLines>
<OrderPickabilityOrderLineInfo>
<OrderLineSystemId>int</OrderLineSystemId>
<Article>
<ArticleSystemId>int</ArticleSystemId>
<ArticleNumber>string</ArticleNumber>
<ArticleName>string</ArticleName>
<ProductCode>string</ProductCode>
<ArticleKind>Stock or Production or Structure or NonStock</ArticleKind>
</Article>
<DoPick>boolean</DoPick>
<ExternalOrderLineCode>string</ExternalOrderLineCode>
<OrderLinePickability>
<Pickability>Ok or ByPriority or NotByPriority or NotOk or NothingToAllocate</Pickability>
<PickabilityWithMove>Ok or ByPriority or NotByPriority or NotOk or NothingToAllocate</PickabilityWithMove>
<PickabilityFromPickingLocations>Ok or ByPriority or NotByPriority or NotOk or NothingToAllocate</PickabilityFromPickingLocations>
<ExpectedPickable>
<ExpectedInDate>dateTime</ExpectedInDate>
<IsPickableByAdvised>boolean</IsPickableByAdvised>
</ExpectedPickable>
</OrderLinePickability>
<IsParentLine>boolean</IsParentLine>
<OrderedNumberOfItems>decimal</OrderedNumberOfItems>
<AllocatedNumberOfItems>decimal</AllocatedNumberOfItems>
<PickedNumberOfItems>decimal</PickedNumberOfItems>
<ParentOrderLine>
<ExternalOrderLineCode>string</ExternalOrderLineCode>
<OrderLineId>int</OrderLineId>
</ParentOrderLine>
</OrderPickabilityOrderLineInfo>
<OrderPickabilityOrderLineInfo>
<OrderLineSystemId>int</OrderLineSystemId>
<Article>
<ArticleSystemId>int</ArticleSystemId>
<ArticleNumber>string</ArticleNumber>
<ArticleName>string</ArticleName>
<ProductCode>string</ProductCode>
<ArticleKind>Stock or Production or Structure or NonStock</ArticleKind>
</Article>
<DoPick>boolean</DoPick>
<ExternalOrderLineCode>string</ExternalOrderLineCode>
<OrderLinePickability>
<Pickability>Ok or ByPriority or NotByPriority or NotOk or NothingToAllocate</Pickability>
<PickabilityWithMove>Ok or ByPriority or NotByPriority or NotOk or NothingToAllocate</PickabilityWithMove>
<PickabilityFromPickingLocations>Ok or ByPriority or NotByPriority or NotOk or NothingToAllocate</PickabilityFromPickingLocations>
<ExpectedPickable>
<ExpectedInDate>dateTime</ExpectedInDate>
<IsPickableByAdvised>boolean</IsPickableByAdvised>
</ExpectedPickable>
</OrderLinePickability>
<IsParentLine>boolean</IsParentLine>
<OrderedNumberOfItems>decimal</OrderedNumberOfItems>
<AllocatedNumberOfItems>decimal</AllocatedNumberOfItems>
<PickedNumberOfItems>decimal</PickedNumberOfItems>
<ParentOrderLine>
<ExternalOrderLineCode>string</ExternalOrderLineCode>
<OrderLineId>int</OrderLineId>
</ParentOrderLine>
</OrderPickabilityOrderLineInfo>
</OrderLines>
</OrderPickabilityResult>
<OrderPickabilityResult>
<OrderInfo>
<OrderId>int</OrderId>
<GoodsOwnerOrderNumber>string</GoodsOwnerOrderNumber>
<GoodsOwnerOrderId>string</GoodsOwnerOrderId>
<OrderStatus>
<OrderStatusNumber>int</OrderStatusNumber>
<OrderStatusText>string</OrderStatusText>
</OrderStatus>
</OrderInfo>
<OrderPickability>
<Pickability>Ok or ByPriority or NotByPriority or NotOk or NothingToAllocate</Pickability>
<PickabilityWithMove>Ok or ByPriority or NotByPriority or NotOk or NothingToAllocate</PickabilityWithMove>
<PickabilityFromPickingLocations>Ok or ByPriority or NotByPriority or NotOk or NothingToAllocate</PickabilityFromPickingLocations>
<ExpectedPickable>
<ExpectedInDate>dateTime</ExpectedInDate>
<IsPickableByAdvised>boolean</IsPickableByAdvised>
</ExpectedPickable>
</OrderPickability>
<OrderLines>
<OrderPickabilityOrderLineInfo>
<OrderLineSystemId>int</OrderLineSystemId>
<Article>
<ArticleSystemId>int</ArticleSystemId>
<ArticleNumber>string</ArticleNumber>
<ArticleName>string</ArticleName>
<ProductCode>string</ProductCode>
<ArticleKind>Stock or Production or Structure or NonStock</ArticleKind>
</Article>
<DoPick>boolean</DoPick>
<ExternalOrderLineCode>string</ExternalOrderLineCode>
<OrderLinePickability>
<Pickability>Ok or ByPriority or NotByPriority or NotOk or NothingToAllocate</Pickability>
<PickabilityWithMove>Ok or ByPriority or NotByPriority or NotOk or NothingToAllocate</PickabilityWithMove>
<PickabilityFromPickingLocations>Ok or ByPriority or NotByPriority or NotOk or NothingToAllocate</PickabilityFromPickingLocations>
<ExpectedPickable>
<ExpectedInDate>dateTime</ExpectedInDate>
<IsPickableByAdvised>boolean</IsPickableByAdvised>
</ExpectedPickable>
</OrderLinePickability>
<IsParentLine>boolean</IsParentLine>
<OrderedNumberOfItems>decimal</OrderedNumberOfItems>
<AllocatedNumberOfItems>decimal</AllocatedNumberOfItems>
<PickedNumberOfItems>decimal</PickedNumberOfItems>
<ParentOrderLine>
<ExternalOrderLineCode>string</ExternalOrderLineCode>
<OrderLineId>int</OrderLineId>
</ParentOrderLine>
</OrderPickabilityOrderLineInfo>
<OrderPickabilityOrderLineInfo>
<OrderLineSystemId>int</OrderLineSystemId>
<Article>
<ArticleSystemId>int</ArticleSystemId>
<ArticleNumber>string</ArticleNumber>
<ArticleName>string</ArticleName>
<ProductCode>string</ProductCode>
<ArticleKind>Stock or Production or Structure or NonStock</ArticleKind>
</Article>
<DoPick>boolean</DoPick>
<ExternalOrderLineCode>string</ExternalOrderLineCode>
<OrderLinePickability>
<Pickability>Ok or ByPriority or NotByPriority or NotOk or NothingToAllocate</Pickability>
<PickabilityWithMove>Ok or ByPriority or NotByPriority or NotOk or NothingToAllocate</PickabilityWithMove>
<PickabilityFromPickingLocations>Ok or ByPriority or NotByPriority or NotOk or NothingToAllocate</PickabilityFromPickingLocations>
<ExpectedPickable>
<ExpectedInDate>dateTime</ExpectedInDate>
<IsPickableByAdvised>boolean</IsPickableByAdvised>
</ExpectedPickable>
</OrderLinePickability>
<IsParentLine>boolean</IsParentLine>
<OrderedNumberOfItems>decimal</OrderedNumberOfItems>
<AllocatedNumberOfItems>decimal</AllocatedNumberOfItems>
<PickedNumberOfItems>decimal</PickedNumberOfItems>
<ParentOrderLine>
<ExternalOrderLineCode>string</ExternalOrderLineCode>
<OrderLineId>int</OrderLineId>
</ParentOrderLine>
</OrderPickabilityOrderLineInfo>
</OrderLines>
</OrderPickabilityResult>
</OrderPickabilityResults>
<Error>
<ErrorType>Unknown or LogonError or NoFilterSpecified</ErrorType>
<Message>string</Message>
</Error>
</GetOrdersPickabilityByQueryResult>
</GetOrdersPickabilityByQueryResponse>
</soap:Body>
</soap:Envelope>
Response specification
| GetOrdersPickabilityByQueryResponse |
| GetOrdersPickabilityByQueryResult |
GetOrdersPickabilityResult |
|
| GetOrdersPickabilityResult |
| Success |
boolean |
|
| OrderPickabilityResults |
OrderPickabilityResult[] |
Containing elements of OrderPickabilityResult |
| Error |
GetOrderPickabilityErrorResult |
An element of type GetOrderPickabilityErrorResult. |
| OrderPickabilityResult |
| OrderInfo |
OrderPickabilityOrderInfo |
An element of type OrderPickabilityOrderInfo. |
| OrderPickability |
OrderPickabilityInfo |
An element of type OrderPickabilityInfo. |
| OrderLines |
OrderPickabilityOrderLineInfo[] |
|
| GetOrderPickabilityErrorResult |
| ErrorType |
enum |
An element of type GetOrderPickabilityErrorType. |
| Message |
string |
|
| OrderPickabilityOrderInfo |
| OrderId |
int |
|
| GoodsOwnerOrderNumber |
string |
|
| GoodsOwnerOrderId |
string |
|
| OrderStatus |
OrderPickabilityOrderStatusInfo |
An element of type OrderPickabilityOrderStatusInfo. |
| OrderPickabilityInfo |
| Pickability |
enum |
An element of type GetOrderPickabilityEnum. |
| PickabilityWithMove |
enum |
An element of type GetOrderPickabilityEnum. |
| PickabilityFromPickingLocations |
enum |
An element of type GetOrderPickabilityEnum. |
| ExpectedPickable |
OrderPickabilityOrderExpectedPickable |
An element of type OrderPickabilityOrderExpectedPickable. |
| OrderPickabilityOrderLineInfo |
| OrderLineSystemId |
int |
|
| Article |
OrderPickabilityArticle |
An element of type OrderPickabilityArticle. |
| DoPick |
boolean |
|
| ExternalOrderLineCode |
string |
|
| OrderLinePickability |
OrderLinePickabilityInfo |
An element of type OrderLinePickabilityInfo. |
| IsParentLine |
boolean |
True if this is a parent order line |
| OrderedNumberOfItems |
decimal |
|
| AllocatedNumberOfItems |
decimal |
|
| PickedNumberOfItems |
decimal |
|
| ParentOrderLine |
OrderPickabilityParentOrderLineInfo |
An element of type OrderPickabilityParentOrderLineInfo. |
| OrderPickabilityOrderStatusInfo |
| OrderStatusNumber |
int |
|
| OrderStatusText |
string |
|
| OrderPickabilityOrderExpectedPickable |
| ExpectedInDate |
dateTime |
|
| IsPickableByAdvised |
boolean |
|
| OrderPickabilityArticle |
| ArticleSystemId |
int |
|
| ArticleNumber |
string |
|
| ArticleName |
string |
|
| ProductCode |
string |
|
| ArticleKind |
enum |
An element of type ArticleKindEnum. |
| OrderLinePickabilityInfo |
| Pickability |
enum |
An element of type GetOrderPickabilityEnum. |
| PickabilityWithMove |
enum |
An element of type GetOrderPickabilityEnum. |
| PickabilityFromPickingLocations |
enum |
An element of type GetOrderPickabilityEnum. |
| ExpectedPickable |
OrderPickabilityOrderLineExpectedPickable |
An element of type OrderPickabilityOrderLineExpectedPickable. |
| OrderPickabilityParentOrderLineInfo |
| ExternalOrderLineCode |
string |
|
| OrderLineId |
int |
If the order line is a sub orderline, then ParentOrderLineIdis the system id of the parent order line |
| OrderPickabilityOrderLineExpectedPickable |
| ExpectedInDate |
dateTime |
|
| IsPickableByAdvised |
boolean |
|