Ongoing WMS logo

Ongoing WMS Developer

GetArticleItemsByQuery

Returns all article items which match a particular query.

Tags: GetArticleItemsByQuery, Query, SpecialFilters, Paging, GetArticleItemsByQueryResponse, GetArticleItemsByQueryResult, ArticleItemInfo, ArticleInfo, ArticleInfoAlternativeBarcode, ArticleInfoAlternativeBarcodeType, InOrderInfo, ReturnInfo

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

<?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>
      <GetArticleItemsByQuery 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>
            <SpecialFilters>
               <OnlyGetArticleItemsInLocationsToBeHandled>boolean</OnlyGetArticleItemsInLocationsToBeHandled>
               <IsLockedByItemLock>boolean</IsLockedByItemLock>
            </SpecialFilters>
            <LocationTypeCode>string</LocationTypeCode>
            <Paging>
               <MaxArticleItemsToGet>int</MaxArticleItemsToGet>
            </Paging>
         </Query>
      </GetArticleItemsByQuery>
   </soap:Body>
</soap:Envelope>
+

Request specification

GetArticleItemsByQuery
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 goodsowner
ArticleItemId int Filter for this particular article item
ArticleDefId int Filter for this particular article
SpecialFilters object A SpecialFilters object
Paging object A Paging object
SpecialFilters
OnlyGetArticleItemsInLocationsToBeHandled bool Filter for article items which have been marked as "to be handled" by ArticleItemInLocationHandled
IsLockedByItemLock bool Filter for article items which have been marked as "locked" in Ongoing WMS
Paging
MaxArticleItemsToGet int Max number of article items to return in response

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>
      <GetArticleItemsByQueryResponse xmlns="http://ongoingsystems.se/Automation">
         <GetArticleItemsByQueryResult>
            <Success>boolean</Success>
            <Message>string</Message>
            <ArticleItems>
               <ArticleItemInfo>
                  <Article>
                     <ArticleName>string</ArticleName>
                     <ArticleNumber>string</ArticleNumber>
                     <ArticleDefId>int</ArticleDefId>
                     <GoodsOwnerName>string</GoodsOwnerName>
                     <GoodsOwnerId>int</GoodsOwnerId>
                     <ArticleGroupCode>string</ArticleGroupCode>
                     <ProductCode>string</ProductCode>
                     <BarCode>string</BarCode>
                     <ArticleUnitCode>string</ArticleUnitCode>
                     <Description>string</Description>
                     <LinkToPicture>string</LinkToPicture>
                     <Weight>decimal</Weight>
                     <Length>decimal</Length>
                     <Width>decimal</Width>
                     <Height>decimal</Height>
                     <AlternativeBarcodes>
                        <ArticleInfoAlternativeBarcode>
                           <BarCode>string</BarCode>
                           <QuantityPerBarcode>decimal</QuantityPerBarcode>
                           <Type>
                              <Name>string</Name>
                              <Code>string</Code>
                           </Type>
                        </ArticleInfoAlternativeBarcode>
                        <ArticleInfoAlternativeBarcode>
                           <BarCode>string</BarCode>
                           <QuantityPerBarcode>decimal</QuantityPerBarcode>
                           <Type>
                              <Name>string</Name>
                              <Code>string</Code>
                           </Type>
                        </ArticleInfoAlternativeBarcode>
                     </AlternativeBarcodes>
                  </Article>
                  <Serial>string</Serial>
                  <Batch>string</Batch>
                  <NumberOfItems>decimal</NumberOfItems>
                  <ArticleItemId>int</ArticleItemId>
                  <ArticleItemInLocationId>int</ArticleItemInLocationId>
                  <Location>string</Location>
                  <OriginalArticleItemId>int</OriginalArticleItemId>
                  <InOrderInfo>
                     <InOrderId>int</InOrderId>
                     <InOrderNumber>string</InOrderNumber>
                  </InOrderInfo>
                  <ReturnInfo>
                     <LastReturnTime>dateTime</LastReturnTime>
                  </ReturnInfo>
                  <ExpiryDate>dateTime</ExpiryDate>
                  <Container>string</Container>
               </ArticleItemInfo>
               <ArticleItemInfo>
                  <Article>
                     <ArticleName>string</ArticleName>
                     <ArticleNumber>string</ArticleNumber>
                     <ArticleDefId>int</ArticleDefId>
                     <GoodsOwnerName>string</GoodsOwnerName>
                     <GoodsOwnerId>int</GoodsOwnerId>
                     <ArticleGroupCode>string</ArticleGroupCode>
                     <ProductCode>string</ProductCode>
                     <BarCode>string</BarCode>
                     <ArticleUnitCode>string</ArticleUnitCode>
                     <Description>string</Description>
                     <LinkToPicture>string</LinkToPicture>
                     <Weight>decimal</Weight>
                     <Length>decimal</Length>
                     <Width>decimal</Width>
                     <Height>decimal</Height>
                     <AlternativeBarcodes>
                        <ArticleInfoAlternativeBarcode>
                           <BarCode>string</BarCode>
                           <QuantityPerBarcode>decimal</QuantityPerBarcode>
                           <Type>
                              <Name>string</Name>
                              <Code>string</Code>
                           </Type>
                        </ArticleInfoAlternativeBarcode>
                        <ArticleInfoAlternativeBarcode>
                           <BarCode>string</BarCode>
                           <QuantityPerBarcode>decimal</QuantityPerBarcode>
                           <Type>
                              <Name>string</Name>
                              <Code>string</Code>
                           </Type>
                        </ArticleInfoAlternativeBarcode>
                     </AlternativeBarcodes>
                  </Article>
                  <Serial>string</Serial>
                  <Batch>string</Batch>
                  <NumberOfItems>decimal</NumberOfItems>
                  <ArticleItemId>int</ArticleItemId>
                  <ArticleItemInLocationId>int</ArticleItemInLocationId>
                  <Location>string</Location>
                  <OriginalArticleItemId>int</OriginalArticleItemId>
                  <InOrderInfo>
                     <InOrderId>int</InOrderId>
                     <InOrderNumber>string</InOrderNumber>
                  </InOrderInfo>
                  <ReturnInfo>
                     <LastReturnTime>dateTime</LastReturnTime>
                  </ReturnInfo>
                  <ExpiryDate>dateTime</ExpiryDate>
                  <Container>string</Container>
               </ArticleItemInfo>
            </ArticleItems>
         </GetArticleItemsByQueryResult>
      </GetArticleItemsByQueryResponse>
   </soap:Body>
</soap:Envelope>
+

Response specification

GetArticleItemsByQueryResponse
GetArticleItemsByQueryResult obj A GetArticleItemsByQueryResult object
GetArticleItemsByQueryResult
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 ArticleItemInfo objects
ArticleItemInfo
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
ArticleItemInLocationId int The internal id of the last move transaction of the article item id
Location str(50) Name of the current location where the article item is placed
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.
InOrderInfo object An InOrderInfo object, containing information about the articles inorder (i.e. purchase order)
ReturnInfo object A ReturnInfo object, containing information about if and when the item have been returned to the warehouse
ExpiryDate dateTime The expiry date of the item.
Container str(50) The container number of the 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 goodsowner to which the article belongs
GoodsOwnerId int The internal system id of the goodsowner 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
ArticleUnitCode str(50) The unit code of the article (e.g. "pcs")
Description str(3000) The article description
LinkToPicture str(300) An URL to an image of the article
Weight decimal The article weight
Length decimal The article lenght
Width decimal The article width
Height decimal The article height
AlternativeBarcodes ArticleInfoAlternativeBarcode[] Alternative barcodes for this article. Used for defining different package sizes or just defining extra barcodes to identify an article. Contains ArticleInfoAlternativeBarcode objects
ArticleInfoAlternativeBarcode
Barcode str(100) The alternative barcode.
QuantityPerBarcode decimal The package size if this is used to define a package.
Type object An ArticleInfoAlternativeBarcodeType object.
ArticleInfoAlternativeBarcodeType
Name str(300) The name of the type.
Code str(300) The code of the type.
InOrderInfo
InOrderId int Ongoing WMS internal id of the inorder
InOrderNumber str(50) The order number of the inorder
ReturnInfo
LastReturnTime datetime This timestamp indicates that this specific item have been returned to the warehouse at least once. The most recent return time is always presented