Ongoing Warehouse Developer

GetOrderArticleItemsByQuery

This call allows you to query for information about article items which have been picked on orders. The call will return all article items matching the specified query, and for each article item it will also give information about the order which the article item was picked on.

The difference between this call and GetArticleItemsByQuery, is that only picked article items will be returned in this call.

Tags: GetOrderArticleItemsByQuery, Query, GetOrderArticleItemsByQueryResponse, GetOrderArticleItemsByQueryResult, OrderArticleItemInfo, ArticleInfo, OrderInfo, OrderArticleItemInfoConsignee

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/GetOrderArticleItemsByQuery"

<?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>
    <GetOrderArticleItemsByQuery xmlns="http://ongoingsystems.se/Automation">
      <UserName>string</UserName>
      <Password>string</Password>
      <Query>
        <Locations>
          <string>string</string>
          <string>string</string>
        </Locations>
        <GoodsOwnerId>int</GoodsOwnerId>
        <ArticleItemId>int</ArticleItemId>
        <ArticleDefId>int</ArticleDefId>
        <OnlyLiveGoodsOwners>boolean</OnlyLiveGoodsOwners>
        <OrderStatusFrom>int</OrderStatusFrom>
        <OrderStatusTo>int</OrderStatusTo>
        <SerialNumber>string</SerialNumber>
        <OrderPalletItemLabelId>string</OrderPalletItemLabelId>
      </Query>
    </GetOrderArticleItemsByQuery>
  </soap:Body>
</soap:Envelope>
+

Request specification

GetOrderArticleItemsByQuery
UserName str(50) Req. Your username.
Password str(50) Req. Your password.
Query object Req. A Query object
Query
Locations str[] Filter for article items in these locations
GoodsOwnerId int Filter for article items belonging to this goods owner
ArticleItemId int Filter for this particular article item
ArticleDefId int Filter for this particular article
OnlyLiveGoodsOwners bool If true, only return article items belonging to goods owners which have been marked as "live" (i.e. goods owners which are not used for testing or training).
OrderStatusFrom int Only return article items belonging to orders whose status are greater than or equal to this value
OrderStatusTo int Only return article items belonging to orders whose status are less than or equal to this value
SerialNumber str(128) Return article items whose serial number is equal to this value
OrderPalletItemLabelId str(30) Return article items which have been placed in a pallet/collie with the specified label id

Response XML

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?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>
    <GetOrderArticleItemsByQueryResponse xmlns="http://ongoingsystems.se/Automation">
      <GetOrderArticleItemsByQueryResult>
        <Success>boolean</Success>
        <Message>string</Message>
        <ArticleItems>
          <OrderArticleItemInfo>
            <Article xsi:nil="true" />
            <OrderPalletItemLabelId>string</OrderPalletItemLabelId>
            <Serial>string</Serial>
            <Batch>string</Batch>
            <NumberOfItems>decimal</NumberOfItems>
            <ArticleItemId>int</ArticleItemId>
            <Location>string</Location>
            <OrderInfo xsi:nil="true" />
            <OriginalArticleItemId>int</OriginalArticleItemId>
          </OrderArticleItemInfo>
          <OrderArticleItemInfo>
            <Article xsi:nil="true" />
            <OrderPalletItemLabelId>string</OrderPalletItemLabelId>
            <Serial>string</Serial>
            <Batch>string</Batch>
            <NumberOfItems>decimal</NumberOfItems>
            <ArticleItemId>int</ArticleItemId>
            <Location>string</Location>
            <OrderInfo xsi:nil="true" />
            <OriginalArticleItemId>int</OriginalArticleItemId>
          </OrderArticleItemInfo>
        </ArticleItems>
      </GetOrderArticleItemsByQueryResult>
    </GetOrderArticleItemsByQueryResponse>
  </soap:Body>
</soap:Envelope>
+

Response specification

GetOrderArticleItemsByQueryResponse
GetOrderArticleItemsByQueryResponse obj A GetOrderArticleItemsByQueryResult object
GetOrderArticleItemsByQueryResult
Success bool True if the call succeeded, false otherwise
Message str If the call failed, this field contains the error message
ArticleItems ArticleItemInfo[] The article items which matched the filter, as a list of OrderArticleItemInfo objects
OrderArticleItemInfo
Article object An ArticleInfo object, containing information about the article definition
Serial str(128) The serial number of the article item
Batch str(50) The batch number of the article item
NumberOfItems dec The quantity
ArticleItemId int The internal system id of the article item
Location str(50) Name of the current location where the article item is placed
OrderInfo object An OrderInfo object, containing information about the order which the article item belongs to
OriginalArticleItemId int The original article item id of this item. If an article item has been created by splitting a previously existing article item, this field will tell you the id of the original article item.
ArticleInfo
ArticleName str(200) The article name
ArticleNumber str(100) The article number
ArticleDefId int The internal system id of the article
GoodsOwnerName str(400) The name of the goods owner to which the article belongs
GoodsOwnerId int The internal system id of the goods owner to which the article belongs
ArticleGroupCode str(100) The code of the group to which the article belongs
ProductCode str(200) Product code
BarCode str(100) The barcode/EAN of the article
OrderInfo
OrderId int Ongoing's internal id for the order
OrderNumber str(50) The goods owner order number
Consignee object An OrderArticleItemInfoConsignee object, containing information about the order's consignee (customer)
OrderArticleItemInfoConsignee
Name str(200) The name of the consignee
CustomerGroupCode str(50) The code of the group which the customer belongs to
CustomerGroupName str(100) The name for the group which the customer belongs to