GetArticleItemsByQuery

Returns all article items which match a particular query.

Tags: GetArticleItemsByQuery, GetArticleItemsQuery, ArticleItemsSpecialFilters, ArticleItemsPaging, Handling_GetArticleItems, GetArticleItemsByQueryResponse, GetArticleItemsResult, ArticleItemInfo, ArticleInfo, GetArticleItemsInOrderInfo, GetArticleItemsReturnInfo, GetArticleItemsOrderInfo, PalletItem_GetArticleItems, MovementArticleItem_GetArticleItems, ArticleInfoAlternativeBarcode, ArticleClassInfoAutomation, WorkOrder_GetArticleItems, ToLocation_GetArticleItems, ArticleInfoAlternativeBarcodeType

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>
        <SerialNumbers>
          <string>string</string>
          <string>string</string>
        </SerialNumbers>
        <SpecialFilters>
          <OnlyGetArticleItemsInLocationsToBeHandled>boolean</OnlyGetArticleItemsInLocationsToBeHandled>
          <IsLockedByItemLock>boolean</IsLockedByItemLock>
          <ArticleItemPalletItemId>int</ArticleItemPalletItemId>
          <ArticleItemPalletItemLabelId>string</ArticleItemPalletItemLabelId>
          <ArticleItemParentPalletItemId>int</ArticleItemParentPalletItemId>
          <ArticleItemParentPalletItemLabelId>string</ArticleItemParentPalletItemLabelId>
          <OnlyArticleItemsAllocatedButNotPickedOnOrderIds>
            <int>int</int>
            <int>int</int>
          </OnlyArticleItemsAllocatedButNotPickedOnOrderIds>
        </SpecialFilters>
        <LocationTypeCode>string</LocationTypeCode>
        <Paging>
          <MaxArticleItemsToGet>int</MaxArticleItemsToGet>
          <ArticleItemIdFrom>int</ArticleItemIdFrom>
        </Paging>
        <OnlyLiveGoodsOwners>boolean</OnlyLiveGoodsOwners>
        <InOrderIds>
          <int>int</int>
          <int>int</int>
        </InOrderIds>
        <PickOrderId>int</PickOrderId>
        <Handling>
          <GetMovementArticleItems>boolean</GetMovementArticleItems>
        </Handling>
      </Query>
    </GetArticleItemsByQuery>
  </soap:Body>
</soap:Envelope>

Request specification

GetArticleItemsByQuery
UserName	string(50)	Req.	Your username
Password	string(50)	Req.	Your password
Query	GetArticleItemsQuery	Req.	The query object

GetArticleItemsQuery
Locations	string[]	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
SerialNumbers	string[]	Filter for article items with these serial numbers
SpecialFilters	ArticleItemsSpecialFilters	A SpecialFilters object
LocationTypeCode	string	Filter for locations with a specific location type code
Paging	ArticleItemsPaging	A Paging object
OnlyLiveGoodsOwners	boolean	If this is set to true, only article items belonging to live goods owners will be returned
InOrderIds	int[]	A list of inorder IDs
PickOrderId	int	Filter for this particular pick order
Handling	Handling_GetArticleItems	Decide if more info is needed (Null = default behavior).

ArticleItemsSpecialFilters
OnlyGetArticleItemsInLocationsToBeHandled	boolean	Filter for article items which have been marked as "to be handled" by ArticleItemInLocationHandled
IsLockedByItemLock	boolean	Filter for article items which have been marked as "locked" in Ongoing WMS
ArticleItemPalletItemId	int	Filter for article items which have been packed on this pallet item ID
ArticleItemPalletItemLabelId	string	Filter for article items which have been packed on the pallet item with this label
ArticleItemParentPalletItemId	int	Only used for "pallet-in-pallet" situations. Filter for article items with this parent pallet item ID
ArticleItemParentPalletItemLabelId	string	Only used for "pallet-in-pallet" situations. Filter for article items with this parent pallet item label
OnlyArticleItemsAllocatedButNotPickedOnOrderIds	int[]	Only return article items which are currently allocated (but not picked) to these order IDs.

ArticleItemsPaging
MaxArticleItemsToGet	int		Max number of article items to return in response
ArticleItemIdFrom	int

Handling_GetArticleItems
GetMovementArticleItems	boolean

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>
    <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>
              <ArticleReturnHandlingComment>string</ArticleReturnHandlingComment>
              <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>
              <ArticleClasses>
                <ArticleClass>
                  <Name>string</Name>
                  <Code>string</Code>
                  <Id>int</Id>
                </ArticleClass>
                <ArticleClass>
                  <Name>string</Name>
                  <Code>string</Code>
                  <Id>int</Id>
                </ArticleClass>
              </ArticleClasses>
              <IsSerialNumberArticle>boolean</IsSerialNumberArticle>
              <IsExpiryDateArticle>boolean</IsExpiryDateArticle>
              <ArticlePickHandlingComment>string</ArticlePickHandlingComment>
              <ArticleInboundHandlingComment>string</ArticleInboundHandlingComment>
            </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>
              <IsReturnInOrder>boolean</IsReturnInOrder>
            </InOrderInfo>
            <ReturnInfo>
              <LastReturnTime>dateTime</LastReturnTime>
            </ReturnInfo>
            <ExpiryDate>dateTime</ExpiryDate>
            <Container>string</Container>
            <IsLocked>boolean</IsLocked>
            <IsLockedForSale>boolean</IsLockedForSale>
            <Order>
              <OrderId>int</OrderId>
            </Order>
            <PalletItem>
              <PalletItemId>int</PalletItemId>
              <LabelId>string</LabelId>
            </PalletItem>
            <MovementArticleItems>
              <MovementArticleItem_GetArticleItems>
                <WorkOrder>
                  <WorkOrderId>int</WorkOrderId>
                </WorkOrder>
                <Executed>boolean</Executed>
                <ExecutedTime>dateTime</ExecutedTime>
                <Created>dateTime</Created>
                <ToLocation>
                  <Location>string</Location>
                  <LocationId>int</LocationId>
                </ToLocation>
                <MovementArticleItemId>int</MovementArticleItemId>
              </MovementArticleItem_GetArticleItems>
              <MovementArticleItem_GetArticleItems>
                <WorkOrder>
                  <WorkOrderId>int</WorkOrderId>
                </WorkOrder>
                <Executed>boolean</Executed>
                <ExecutedTime>dateTime</ExecutedTime>
                <Created>dateTime</Created>
                <ToLocation>
                  <Location>string</Location>
                  <LocationId>int</LocationId>
                </ToLocation>
                <MovementArticleItemId>int</MovementArticleItemId>
              </MovementArticleItem_GetArticleItems>
            </MovementArticleItems>
            <InDate>dateTime</InDate>
            <LastMoveTime>dateTime</LastMoveTime>
            <Comment>string</Comment>
            <ArticleItemWeight>decimal</ArticleItemWeight>
            <CaseNo>string</CaseNo>
            <ProductionDate>dateTime</ProductionDate>
          </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>
              <ArticleReturnHandlingComment>string</ArticleReturnHandlingComment>
              <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>
              <ArticleClasses>
                <ArticleClass>
                  <Name>string</Name>
                  <Code>string</Code>
                  <Id>int</Id>
                </ArticleClass>
                <ArticleClass>
                  <Name>string</Name>
                  <Code>string</Code>
                  <Id>int</Id>
                </ArticleClass>
              </ArticleClasses>
              <IsSerialNumberArticle>boolean</IsSerialNumberArticle>
              <IsExpiryDateArticle>boolean</IsExpiryDateArticle>
              <ArticlePickHandlingComment>string</ArticlePickHandlingComment>
              <ArticleInboundHandlingComment>string</ArticleInboundHandlingComment>
            </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>
              <IsReturnInOrder>boolean</IsReturnInOrder>
            </InOrderInfo>
            <ReturnInfo>
              <LastReturnTime>dateTime</LastReturnTime>
            </ReturnInfo>
            <ExpiryDate>dateTime</ExpiryDate>
            <Container>string</Container>
            <IsLocked>boolean</IsLocked>
            <IsLockedForSale>boolean</IsLockedForSale>
            <Order>
              <OrderId>int</OrderId>
            </Order>
            <PalletItem>
              <PalletItemId>int</PalletItemId>
              <LabelId>string</LabelId>
            </PalletItem>
            <MovementArticleItems>
              <MovementArticleItem_GetArticleItems>
                <WorkOrder>
                  <WorkOrderId>int</WorkOrderId>
                </WorkOrder>
                <Executed>boolean</Executed>
                <ExecutedTime>dateTime</ExecutedTime>
                <Created>dateTime</Created>
                <ToLocation>
                  <Location>string</Location>
                  <LocationId>int</LocationId>
                </ToLocation>
                <MovementArticleItemId>int</MovementArticleItemId>
              </MovementArticleItem_GetArticleItems>
              <MovementArticleItem_GetArticleItems>
                <WorkOrder>
                  <WorkOrderId>int</WorkOrderId>
                </WorkOrder>
                <Executed>boolean</Executed>
                <ExecutedTime>dateTime</ExecutedTime>
                <Created>dateTime</Created>
                <ToLocation>
                  <Location>string</Location>
                  <LocationId>int</LocationId>
                </ToLocation>
                <MovementArticleItemId>int</MovementArticleItemId>
              </MovementArticleItem_GetArticleItems>
            </MovementArticleItems>
            <InDate>dateTime</InDate>
            <LastMoveTime>dateTime</LastMoveTime>
            <Comment>string</Comment>
            <ArticleItemWeight>decimal</ArticleItemWeight>
            <CaseNo>string</CaseNo>
            <ProductionDate>dateTime</ProductionDate>
          </ArticleItemInfo>
        </ArticleItems>
      </GetArticleItemsByQueryResult>
    </GetArticleItemsByQueryResponse>
  </soap:Body>
</soap:Envelope>

Response specification

GetArticleItemsByQueryResponse
GetArticleItemsByQueryResult	GetArticleItemsResult

GetArticleItemsResult
Success	boolean	True if the call succeeded, false otherwise
Message	string	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	ArticleInfo	An ArticleInfo object, containing information about the article definition
Serial	string(128)	The serial number of the article item
Batch	string(50)	The batch number of the article item
NumberOfItems	decimal	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	string(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	GetArticleItemsInOrderInfo	An InOrderInfo object, containing information about the articles inorder (i.e. purchase order)
ReturnInfo	GetArticleItemsReturnInfo	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	string(50)	The container number of the item.
IsLocked	boolean	True if item is locked
IsLockedForSale	boolean	True if item is locked for sale
Order	GetArticleItemsOrderInfo	An Order object, containing information about the order which article item has been allocated to. This object may be null.
PalletItem	PalletItem_GetArticleItems	An element of type PalletItem_GetArticleItems.
MovementArticleItems	MovementArticleItem_GetArticleItems[]
InDate	dateTime	Datetime of when the item was received.
LastMoveTime	dateTime	Datetime of when the item was last moved between warehouse locations.
Comment	string	The comment of the item.
ArticleItemWeight	decimal	The article item weight
CaseNo	string(100)	The article item case number
ProductionDate	dateTime	The production date of the item.

ArticleInfo
ArticleName	string(200)	The article name
ArticleNumber	string(200)	The article number
ArticleDefId	int	The internal system id of the article
GoodsOwnerName	string(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	string(100)	The code of the group to which the article belongs
ProductCode	string(200)	Product code
BarCode	string(100)	The barcode/EAN of the article
ArticleUnitCode	string(50)	The unit code of the article (e.g. "pcs")
Description	string(3000)	The article description
ArticleReturnHandlingComment	string(500)	The article return handling comment
LinkToPicture	string(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
ArticleClasses	ArticleClassInfoAutomation[]	Alternative classes for this article. Contains ArticleClassInfoAutomation objects
IsSerialNumberArticle	boolean	True if the article is a serial number article, false otherwise
IsExpiryDateArticle	boolean	True if the article is an expiry date article, false otherwise
ArticlePickHandlingComment	string(500)	The articles pick handling comment
ArticleInboundHandlingComment	string(500)	The articles inbound handling comment

GetArticleItemsInOrderInfo
InOrderId	int	Ongoing WMS internal id of the inorder
InOrderNumber	string(50)	The order number of the inorder
IsReturnInOrder	boolean	This boolean indicates whether the item has been returned to the warehouse on a purchase order marked as a return.

GetArticleItemsReturnInfo
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

GetArticleItemsOrderInfo
OrderId	int	The OrderId which the article item has been allocated to.

PalletItem_GetArticleItems
PalletItemId	int
LabelId	string

MovementArticleItem_GetArticleItems
WorkOrder	WorkOrder_GetArticleItems	An element of type WorkOrder_GetArticleItems.
Executed	boolean
ExecutedTime	dateTime
Created	dateTime
ToLocation	ToLocation_GetArticleItems	An element of type ToLocation_GetArticleItems.
MovementArticleItemId	int

ArticleInfoAlternativeBarcode
Barcode	string(100)	The alternative barcode.
QuantityPerBarcode	decimal	The package size if this is used to define a package.
Type	ArticleInfoAlternativeBarcodeType	An ArticleInfoAlternativeBarcodeType object.

ArticleClassInfoAutomation
Name	string(50)	The name of the article class.
Code	string(50)	The the code of the article class.
Id	int	The Ongoing system ID of the article class.

WorkOrder_GetArticleItems
WorkOrderId	int

ToLocation_GetArticleItems
Location	string
LocationId	int

ArticleInfoAlternativeBarcodeType
Name	string(300)	The name of the type.
Code	string(300)	The code of the type.