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, AutomationGetOrdersPickabilityQuery, AutomationGetOrdersPickabilityQueryPaging, GetOrdersPickabilityByQueryResponse, AutomationGetOrdersPickabilityResult, AutomationOrderPickabilityResult, AutomationGetOrderPickabilityErrorResult, AutomationOrderPickabilityOrderInfo, AutomationOrderPickabilityInfo, AutomationOrderPickabilityOrderLineInfo, AutomationOrderPickabilityOrderStatusInfo, AutomationOrderPickabilityGoodsOwnerInfo, AutomationOrderPickabilityOrderExpectedPickable, AutomationOrderPickabilityArticle, AutomationOrderLinePickabilityInfo, AutomationOrderPickabilityParentOrderLineInfo, AutomationOrderPickabilityOrderLineExpectedPickable

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/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/Automation">
      <UserName>string</UserName>
      <Password>string</Password>
      <Query>
        <OrderNumbersToGet>
          <string>string</string>
          <string>string</string>
        </OrderNumbersToGet>
        <OrderIdsToGet>
          <int>int</int>
          <int>int</int>
        </OrderIdsToGet>
        <OnlyBookedOrders>boolean</OnlyBookedOrders>
        <OnlyLiveGoodsOwners>boolean</OnlyLiveGoodsOwners>
        <Paging>
          <MaxOrdersToGet>int</MaxOrdersToGet>
          <OrderIdFrom>int</OrderIdFrom>
        </Paging>
      </Query>
    </GetOrdersPickabilityByQuery>
  </soap:Body>
</soap:Envelope>

Request specification

GetOrdersPickabilityByQuery
UserName string(50) Req. Your username
Password string(50) Req. Your password
Query AutomationGetOrdersPickabilityQuery Req. The query object
AutomationGetOrdersPickabilityQuery
OrderNumbersToGet string[] Containing elements of string, defining order numbers to get
OrderIdsToGet int[] Containing elements of int, defining order IDs to get
OnlyBookedOrders boolean
OnlyLiveGoodsOwners boolean
Paging AutomationGetOrdersPickabilityQueryPaging An element of type AutomationGetOrdersPickabilityQueryPaging.
AutomationGetOrdersPickabilityQueryPaging
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/Automation">
      <GetOrdersPickabilityByQueryResult>
        <Success>boolean</Success>
        <OrderPickabilityResults>
          <AutomationOrderPickabilityResult>
            <OrderInfo>
              <OrderId>int</OrderId>
              <GoodsOwnerOrderNumber>string</GoodsOwnerOrderNumber>
              <GoodsOwnerOrderId>string</GoodsOwnerOrderId>
              <OrderStatus>
                <OrderStatusNumber>int</OrderStatusNumber>
                <OrderStatusText>string</OrderStatusText>
              </OrderStatus>
              <GoodsOwner>
                <GoodsOwnerId>int</GoodsOwnerId>
                <GoodsOwnerName>string</GoodsOwnerName>
              </GoodsOwner>
            </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>
              <AutomationOrderPickabilityOrderLineInfo>
                <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>
              </AutomationOrderPickabilityOrderLineInfo>
              <AutomationOrderPickabilityOrderLineInfo>
                <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>
              </AutomationOrderPickabilityOrderLineInfo>
            </OrderLines>
          </AutomationOrderPickabilityResult>
          <AutomationOrderPickabilityResult>
            <OrderInfo>
              <OrderId>int</OrderId>
              <GoodsOwnerOrderNumber>string</GoodsOwnerOrderNumber>
              <GoodsOwnerOrderId>string</GoodsOwnerOrderId>
              <OrderStatus>
                <OrderStatusNumber>int</OrderStatusNumber>
                <OrderStatusText>string</OrderStatusText>
              </OrderStatus>
              <GoodsOwner>
                <GoodsOwnerId>int</GoodsOwnerId>
                <GoodsOwnerName>string</GoodsOwnerName>
              </GoodsOwner>
            </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>
              <AutomationOrderPickabilityOrderLineInfo>
                <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>
              </AutomationOrderPickabilityOrderLineInfo>
              <AutomationOrderPickabilityOrderLineInfo>
                <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>
              </AutomationOrderPickabilityOrderLineInfo>
            </OrderLines>
          </AutomationOrderPickabilityResult>
        </OrderPickabilityResults>
        <Error>
          <ErrorType>Unknown or LogonError or NoFilterSpecified</ErrorType>
          <Message>string</Message>
        </Error>
      </GetOrdersPickabilityByQueryResult>
    </GetOrdersPickabilityByQueryResponse>
  </soap:Body>
</soap:Envelope>

Response specification

GetOrdersPickabilityByQueryResponse
GetOrdersPickabilityByQueryResult AutomationGetOrdersPickabilityResult
AutomationGetOrdersPickabilityResult
Success boolean
OrderPickabilityResults AutomationOrderPickabilityResult[] Containing elements of OrderPickabilityResult
Error AutomationGetOrderPickabilityErrorResult An element of type AutomationGetOrderPickabilityErrorResult.
AutomationOrderPickabilityResult
OrderInfo AutomationOrderPickabilityOrderInfo An element of type AutomationOrderPickabilityOrderInfo.
OrderPickability AutomationOrderPickabilityInfo An element of type AutomationOrderPickabilityInfo.
OrderLines AutomationOrderPickabilityOrderLineInfo[]
AutomationGetOrderPickabilityErrorResult
ErrorType enum An element of type AutomationGetOrderPickabilityErrorType.
Message string
AutomationOrderPickabilityOrderInfo
OrderId int
GoodsOwnerOrderNumber string
GoodsOwnerOrderId string
OrderStatus AutomationOrderPickabilityOrderStatusInfo An element of type AutomationOrderPickabilityOrderStatusInfo.
GoodsOwner AutomationOrderPickabilityGoodsOwnerInfo An element of type AutomationOrderPickabilityGoodsOwnerInfo.
AutomationOrderPickabilityInfo
Pickability enum An element of type AutomationGetOrderPickabilityEnum.
PickabilityWithMove enum An element of type AutomationGetOrderPickabilityEnum.
PickabilityFromPickingLocations enum An element of type AutomationGetOrderPickabilityEnum.
ExpectedPickable AutomationOrderPickabilityOrderExpectedPickable An element of type AutomationOrderPickabilityOrderExpectedPickable.
AutomationOrderPickabilityOrderLineInfo
OrderLineSystemId int
Article AutomationOrderPickabilityArticle An element of type AutomationOrderPickabilityArticle.
DoPick boolean
ExternalOrderLineCode string
OrderLinePickability AutomationOrderLinePickabilityInfo An element of type AutomationOrderLinePickabilityInfo.
IsParentLine boolean True if this is a parent order line
OrderedNumberOfItems decimal
AllocatedNumberOfItems decimal
PickedNumberOfItems decimal
ParentOrderLine AutomationOrderPickabilityParentOrderLineInfo An element of type AutomationOrderPickabilityParentOrderLineInfo.
AutomationOrderPickabilityOrderStatusInfo
OrderStatusNumber int
OrderStatusText string
AutomationOrderPickabilityGoodsOwnerInfo
GoodsOwnerId int
GoodsOwnerName string
AutomationOrderPickabilityOrderExpectedPickable
ExpectedInDate dateTime
IsPickableByAdvised boolean
AutomationOrderPickabilityArticle
ArticleSystemId int
ArticleNumber string
ArticleName string
ProductCode string
ArticleKind enum An element of type ArticleKindEnum.
AutomationOrderLinePickabilityInfo
Pickability enum An element of type AutomationGetOrderPickabilityEnum.
PickabilityWithMove enum An element of type AutomationGetOrderPickabilityEnum.
PickabilityFromPickingLocations enum An element of type AutomationGetOrderPickabilityEnum.
ExpectedPickable AutomationOrderPickabilityOrderLineExpectedPickable An element of type AutomationOrderPickabilityOrderLineExpectedPickable.
AutomationOrderPickabilityParentOrderLineInfo
ExternalOrderLineCode string
OrderLineId int If the order line is a sub orderline, then ParentOrderLineIdis the system id of the parent order line
AutomationOrderPickabilityOrderLineExpectedPickable
ExpectedInDate dateTime
IsPickableByAdvised boolean