GetInventoryTaskArticleItems

This function returns detailed information about which items are being inventoried on an inventory task. There can be hundreds of thousands of items on a task, which results in large responses. Therefore, we recommend that you page your results by using ArticleDefIdFrom and MaxArticlesToGet.

The function GetInventoryTasksByQuery can be used to get some basic information about the inventory task itself.

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

<?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>
    <GetInventoryTaskArticleItems xmlns="http://ongoingsystems.se/Automation">
      <UserName>string</UserName>
      <Password>string</Password>
      <Query>
        <InventoryId>int</InventoryId>
        <ArticleDefIdFrom>int</ArticleDefIdFrom>
        <MaxArticlesToGet>int</MaxArticlesToGet>
        <ArticleDefId>int</ArticleDefId>
        <LocationId>int</LocationId>
      </Query>
    </GetInventoryTaskArticleItems>
  </soap:Body>
</soap:Envelope>

Request specification

GetInventoryTaskArticleItems
UserName	string(50)	Req.	Your username
Password	string(50)	Req.	Your password
Query	GetInventoryTaskArticleItemsQuery	Req.	The query object

GetInventoryTaskArticleItemsQuery
InventoryId	int	The inventory task ID.
ArticleDefIdFrom	int	Only return article items whose ArticleDefId is greater than or equal to this.
MaxArticlesToGet	int	Max number of articles to get.
ArticleDefId	int	Only return article items whose ArticleDefId equals this.
LocationId	int	Only return article items in this location.

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>
    <GetInventoryTaskArticleItemsResponse xmlns="http://ongoingsystems.se/Automation">
      <GetInventoryTaskArticleItemsResult>
        <Success>boolean</Success>
        <Inventory>
          <InventoryId>int</InventoryId>
          <InventoryCountNumber>int</InventoryCountNumber>
          <IsActive>boolean</IsActive>
          <GoodsOwnerId>int</GoodsOwnerId>
        </Inventory>
        <PerArticle>
          <PerArticle_GetInventoryTaskArticleItems>
            <Article>
              <ArticleDefId>int</ArticleDefId>
              <ArticleNumber>string</ArticleNumber>
            </Article>
            <PerLocation>
              <PerLocation_GetInventoryTaskArticleItems>
                <Location>
                  <LocationId>int</LocationId>
                  <Location>string</Location>
                </Location>
                <PreInventoryNumberOfItems>decimal</PreInventoryNumberOfItems>
                <InventoryArticleItems>
                  <InventoryArticleItem_GetInventoryTaskArticleItems>
                    <ArticleItem>
                      <ArticleItemId>int</ArticleItemId>
                      <OriginalArticleItemId>int</OriginalArticleItemId>
                      <Serial>string</Serial>
                      <Batch>string</Batch>
                      <NumberOfItems>decimal</NumberOfItems>
                      <ExpiryDate>dateTime</ExpiryDate>
                    </ArticleItem>
                    <Approved>boolean</Approved>
                    <Executed>boolean</Executed>
                    <LastCountNumberOfItems>decimal</LastCountNumberOfItems>
                    <PreInventoryNumberOfItems>decimal</PreInventoryNumberOfItems>
                    <InventoryArticleItemId>int</InventoryArticleItemId>
                    <Counts>
                      <InventoryArticleItemCount_GetInventoryTaskArticleItems>
                        <CountedNumberOfItems>decimal</CountedNumberOfItems>
                        <InventoryCountNumber>int</InventoryCountNumber>
                      </InventoryArticleItemCount_GetInventoryTaskArticleItems>
                      <InventoryArticleItemCount_GetInventoryTaskArticleItems>
                        <CountedNumberOfItems>decimal</CountedNumberOfItems>
                        <InventoryCountNumber>int</InventoryCountNumber>
                      </InventoryArticleItemCount_GetInventoryTaskArticleItems>
                    </Counts>
                  </InventoryArticleItem_GetInventoryTaskArticleItems>
                  <InventoryArticleItem_GetInventoryTaskArticleItems>
                    <ArticleItem>
                      <ArticleItemId>int</ArticleItemId>
                      <OriginalArticleItemId>int</OriginalArticleItemId>
                      <Serial>string</Serial>
                      <Batch>string</Batch>
                      <NumberOfItems>decimal</NumberOfItems>
                      <ExpiryDate>dateTime</ExpiryDate>
                    </ArticleItem>
                    <Approved>boolean</Approved>
                    <Executed>boolean</Executed>
                    <LastCountNumberOfItems>decimal</LastCountNumberOfItems>
                    <PreInventoryNumberOfItems>decimal</PreInventoryNumberOfItems>
                    <InventoryArticleItemId>int</InventoryArticleItemId>
                    <Counts>
                      <InventoryArticleItemCount_GetInventoryTaskArticleItems>
                        <CountedNumberOfItems>decimal</CountedNumberOfItems>
                        <InventoryCountNumber>int</InventoryCountNumber>
                      </InventoryArticleItemCount_GetInventoryTaskArticleItems>
                      <InventoryArticleItemCount_GetInventoryTaskArticleItems>
                        <CountedNumberOfItems>decimal</CountedNumberOfItems>
                        <InventoryCountNumber>int</InventoryCountNumber>
                      </InventoryArticleItemCount_GetInventoryTaskArticleItems>
                    </Counts>
                  </InventoryArticleItem_GetInventoryTaskArticleItems>
                </InventoryArticleItems>
              </PerLocation_GetInventoryTaskArticleItems>
              <PerLocation_GetInventoryTaskArticleItems>
                <Location>
                  <LocationId>int</LocationId>
                  <Location>string</Location>
                </Location>
                <PreInventoryNumberOfItems>decimal</PreInventoryNumberOfItems>
                <InventoryArticleItems>
                  <InventoryArticleItem_GetInventoryTaskArticleItems>
                    <ArticleItem>
                      <ArticleItemId>int</ArticleItemId>
                      <OriginalArticleItemId>int</OriginalArticleItemId>
                      <Serial>string</Serial>
                      <Batch>string</Batch>
                      <NumberOfItems>decimal</NumberOfItems>
                      <ExpiryDate>dateTime</ExpiryDate>
                    </ArticleItem>
                    <Approved>boolean</Approved>
                    <Executed>boolean</Executed>
                    <LastCountNumberOfItems>decimal</LastCountNumberOfItems>
                    <PreInventoryNumberOfItems>decimal</PreInventoryNumberOfItems>
                    <InventoryArticleItemId>int</InventoryArticleItemId>
                    <Counts>
                      <InventoryArticleItemCount_GetInventoryTaskArticleItems>
                        <CountedNumberOfItems>decimal</CountedNumberOfItems>
                        <InventoryCountNumber>int</InventoryCountNumber>
                      </InventoryArticleItemCount_GetInventoryTaskArticleItems>
                      <InventoryArticleItemCount_GetInventoryTaskArticleItems>
                        <CountedNumberOfItems>decimal</CountedNumberOfItems>
                        <InventoryCountNumber>int</InventoryCountNumber>
                      </InventoryArticleItemCount_GetInventoryTaskArticleItems>
                    </Counts>
                  </InventoryArticleItem_GetInventoryTaskArticleItems>
                  <InventoryArticleItem_GetInventoryTaskArticleItems>
                    <ArticleItem>
                      <ArticleItemId>int</ArticleItemId>
                      <OriginalArticleItemId>int</OriginalArticleItemId>
                      <Serial>string</Serial>
                      <Batch>string</Batch>
                      <NumberOfItems>decimal</NumberOfItems>
                      <ExpiryDate>dateTime</ExpiryDate>
                    </ArticleItem>
                    <Approved>boolean</Approved>
                    <Executed>boolean</Executed>
                    <LastCountNumberOfItems>decimal</LastCountNumberOfItems>
                    <PreInventoryNumberOfItems>decimal</PreInventoryNumberOfItems>
                    <InventoryArticleItemId>int</InventoryArticleItemId>
                    <Counts>
                      <InventoryArticleItemCount_GetInventoryTaskArticleItems>
                        <CountedNumberOfItems>decimal</CountedNumberOfItems>
                        <InventoryCountNumber>int</InventoryCountNumber>
                      </InventoryArticleItemCount_GetInventoryTaskArticleItems>
                      <InventoryArticleItemCount_GetInventoryTaskArticleItems>
                        <CountedNumberOfItems>decimal</CountedNumberOfItems>
                        <InventoryCountNumber>int</InventoryCountNumber>
                      </InventoryArticleItemCount_GetInventoryTaskArticleItems>
                    </Counts>
                  </InventoryArticleItem_GetInventoryTaskArticleItems>
                </InventoryArticleItems>
              </PerLocation_GetInventoryTaskArticleItems>
            </PerLocation>
          </PerArticle_GetInventoryTaskArticleItems>
          <PerArticle_GetInventoryTaskArticleItems>
            <Article>
              <ArticleDefId>int</ArticleDefId>
              <ArticleNumber>string</ArticleNumber>
            </Article>
            <PerLocation>
              <PerLocation_GetInventoryTaskArticleItems>
                <Location>
                  <LocationId>int</LocationId>
                  <Location>string</Location>
                </Location>
                <PreInventoryNumberOfItems>decimal</PreInventoryNumberOfItems>
                <InventoryArticleItems>
                  <InventoryArticleItem_GetInventoryTaskArticleItems>
                    <ArticleItem>
                      <ArticleItemId>int</ArticleItemId>
                      <OriginalArticleItemId>int</OriginalArticleItemId>
                      <Serial>string</Serial>
                      <Batch>string</Batch>
                      <NumberOfItems>decimal</NumberOfItems>
                      <ExpiryDate>dateTime</ExpiryDate>
                    </ArticleItem>
                    <Approved>boolean</Approved>
                    <Executed>boolean</Executed>
                    <LastCountNumberOfItems>decimal</LastCountNumberOfItems>
                    <PreInventoryNumberOfItems>decimal</PreInventoryNumberOfItems>
                    <InventoryArticleItemId>int</InventoryArticleItemId>
                    <Counts>
                      <InventoryArticleItemCount_GetInventoryTaskArticleItems>
                        <CountedNumberOfItems>decimal</CountedNumberOfItems>
                        <InventoryCountNumber>int</InventoryCountNumber>
                      </InventoryArticleItemCount_GetInventoryTaskArticleItems>
                      <InventoryArticleItemCount_GetInventoryTaskArticleItems>
                        <CountedNumberOfItems>decimal</CountedNumberOfItems>
                        <InventoryCountNumber>int</InventoryCountNumber>
                      </InventoryArticleItemCount_GetInventoryTaskArticleItems>
                    </Counts>
                  </InventoryArticleItem_GetInventoryTaskArticleItems>
                  <InventoryArticleItem_GetInventoryTaskArticleItems>
                    <ArticleItem>
                      <ArticleItemId>int</ArticleItemId>
                      <OriginalArticleItemId>int</OriginalArticleItemId>
                      <Serial>string</Serial>
                      <Batch>string</Batch>
                      <NumberOfItems>decimal</NumberOfItems>
                      <ExpiryDate>dateTime</ExpiryDate>
                    </ArticleItem>
                    <Approved>boolean</Approved>
                    <Executed>boolean</Executed>
                    <LastCountNumberOfItems>decimal</LastCountNumberOfItems>
                    <PreInventoryNumberOfItems>decimal</PreInventoryNumberOfItems>
                    <InventoryArticleItemId>int</InventoryArticleItemId>
                    <Counts>
                      <InventoryArticleItemCount_GetInventoryTaskArticleItems>
                        <CountedNumberOfItems>decimal</CountedNumberOfItems>
                        <InventoryCountNumber>int</InventoryCountNumber>
                      </InventoryArticleItemCount_GetInventoryTaskArticleItems>
                      <InventoryArticleItemCount_GetInventoryTaskArticleItems>
                        <CountedNumberOfItems>decimal</CountedNumberOfItems>
                        <InventoryCountNumber>int</InventoryCountNumber>
                      </InventoryArticleItemCount_GetInventoryTaskArticleItems>
                    </Counts>
                  </InventoryArticleItem_GetInventoryTaskArticleItems>
                </InventoryArticleItems>
              </PerLocation_GetInventoryTaskArticleItems>
              <PerLocation_GetInventoryTaskArticleItems>
                <Location>
                  <LocationId>int</LocationId>
                  <Location>string</Location>
                </Location>
                <PreInventoryNumberOfItems>decimal</PreInventoryNumberOfItems>
                <InventoryArticleItems>
                  <InventoryArticleItem_GetInventoryTaskArticleItems>
                    <ArticleItem>
                      <ArticleItemId>int</ArticleItemId>
                      <OriginalArticleItemId>int</OriginalArticleItemId>
                      <Serial>string</Serial>
                      <Batch>string</Batch>
                      <NumberOfItems>decimal</NumberOfItems>
                      <ExpiryDate>dateTime</ExpiryDate>
                    </ArticleItem>
                    <Approved>boolean</Approved>
                    <Executed>boolean</Executed>
                    <LastCountNumberOfItems>decimal</LastCountNumberOfItems>
                    <PreInventoryNumberOfItems>decimal</PreInventoryNumberOfItems>
                    <InventoryArticleItemId>int</InventoryArticleItemId>
                    <Counts>
                      <InventoryArticleItemCount_GetInventoryTaskArticleItems>
                        <CountedNumberOfItems>decimal</CountedNumberOfItems>
                        <InventoryCountNumber>int</InventoryCountNumber>
                      </InventoryArticleItemCount_GetInventoryTaskArticleItems>
                      <InventoryArticleItemCount_GetInventoryTaskArticleItems>
                        <CountedNumberOfItems>decimal</CountedNumberOfItems>
                        <InventoryCountNumber>int</InventoryCountNumber>
                      </InventoryArticleItemCount_GetInventoryTaskArticleItems>
                    </Counts>
                  </InventoryArticleItem_GetInventoryTaskArticleItems>
                  <InventoryArticleItem_GetInventoryTaskArticleItems>
                    <ArticleItem>
                      <ArticleItemId>int</ArticleItemId>
                      <OriginalArticleItemId>int</OriginalArticleItemId>
                      <Serial>string</Serial>
                      <Batch>string</Batch>
                      <NumberOfItems>decimal</NumberOfItems>
                      <ExpiryDate>dateTime</ExpiryDate>
                    </ArticleItem>
                    <Approved>boolean</Approved>
                    <Executed>boolean</Executed>
                    <LastCountNumberOfItems>decimal</LastCountNumberOfItems>
                    <PreInventoryNumberOfItems>decimal</PreInventoryNumberOfItems>
                    <InventoryArticleItemId>int</InventoryArticleItemId>
                    <Counts>
                      <InventoryArticleItemCount_GetInventoryTaskArticleItems>
                        <CountedNumberOfItems>decimal</CountedNumberOfItems>
                        <InventoryCountNumber>int</InventoryCountNumber>
                      </InventoryArticleItemCount_GetInventoryTaskArticleItems>
                      <InventoryArticleItemCount_GetInventoryTaskArticleItems>
                        <CountedNumberOfItems>decimal</CountedNumberOfItems>
                        <InventoryCountNumber>int</InventoryCountNumber>
                      </InventoryArticleItemCount_GetInventoryTaskArticleItems>
                    </Counts>
                  </InventoryArticleItem_GetInventoryTaskArticleItems>
                </InventoryArticleItems>
              </PerLocation_GetInventoryTaskArticleItems>
            </PerLocation>
          </PerArticle_GetInventoryTaskArticleItems>
        </PerArticle>
        <Error>
          <ErrorType>Unknown or LogonError or InventoryIdNotFound or GoodsOwnerDeleted</ErrorType>
          <Message>string</Message>
        </Error>
      </GetInventoryTaskArticleItemsResult>
    </GetInventoryTaskArticleItemsResponse>
  </soap:Body>
</soap:Envelope>

Response specification

GetInventoryTaskArticleItemsResponse
GetInventoryTaskArticleItemsResult	GetInventoryTaskArticleItemsResult

GetInventoryTaskArticleItemsResult
Success	boolean
Inventory	InventoryInfo_GetInventoryTaskArticleItems	An element of type InventoryInfo_GetInventoryTaskArticleItems.
PerArticle	PerArticle_GetInventoryTaskArticleItems[]	A list of the article items on this inventory task. The items are grouped first by their ArticleDefId, and then by the LocationId..
Error	GetInventoryTaskArticleItemsErrorResult	An element of type GetInventoryTaskArticleItemsErrorResult.

InventoryInfo_GetInventoryTaskArticleItems
InventoryId	int	The id of the inventory task.
InventoryCountNumber	int	Which count the task is currently on. I.e. when the task starts, it begins with count 1. If there are any discrepancies which the warehouse wants to count again, they can start a new count, resulting in count 2, and so on.
IsActive	boolean	Whether or not the inventory task is active.
GoodsOwnerId	int	The goods owner which the inventory task belongs to.

PerArticle_GetInventoryTaskArticleItems
Article	ArticleInfo_GetInventoryTaskArticleItems	An element of type ArticleInfo_GetInventoryTaskArticleItems.
PerLocation	PerLocation_GetInventoryTaskArticleItems[]

GetInventoryTaskArticleItemsErrorResult
ErrorType	enum	An element of type GetInventoryTaskArticleItemsErrorType.
Message	string

ArticleInfo_GetInventoryTaskArticleItems
ArticleDefId	int
ArticleNumber	string

PerLocation_GetInventoryTaskArticleItems
Location	Location_GetInventoryTaskArticleItems	An element of type Location_GetInventoryTaskArticleItems.
PreInventoryNumberOfItems	decimal
InventoryArticleItems	InventoryArticleItem_GetInventoryTaskArticleItems[]

Location_GetInventoryTaskArticleItems
LocationId	int
Location	string

InventoryArticleItem_GetInventoryTaskArticleItems
ArticleItem	ArticleItem_GetInventoryTaskArticleItems	An element of type ArticleItem_GetInventoryTaskArticleItems.
Approved	boolean
Executed	boolean
LastCountNumberOfItems	decimal
PreInventoryNumberOfItems	decimal
InventoryArticleItemId	int
Counts	InventoryArticleItemCount_GetInventoryTaskArticleItems[]

ArticleItem_GetInventoryTaskArticleItems
ArticleItemId	int
OriginalArticleItemId	int
Serial	string
Batch	string
NumberOfItems	decimal
ExpiryDate	dateTime

InventoryArticleItemCount_GetInventoryTaskArticleItems
CountedNumberOfItems	decimal
InventoryCountNumber	int