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.
Tags: GetInventoryTaskArticleItems, Query, GetInventoryTaskArticleItemsResult
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 |
str(50) |
Req. |
Your username. |
Password |
str(50) |
Req. |
Your password. |
Query |
object |
Req. |
Specifies the query/search criteria |
Query |
InventoryId |
int |
Req |
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
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>
<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 xsi:nil="true" />
<PerLocation xsi:nil="true" />
</PerArticle_GetInventoryTaskArticleItems>
<PerArticle_GetInventoryTaskArticleItems>
<Article xsi:nil="true" />
<PerLocation xsi:nil="true" />
</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
GetInventoryTaskArticleItemsResult |
Success |
bool |
Whether or not the call succeeded |
Inventory > InventoryId |
int |
The id of the inventory task |
Inventory > 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. |
Inventory > IsActive |
bool |
Whether or not the inventory task is active. |
Inventory > GoodsOwnerId |
int |
The goods owner which the inventory task belongs to. |
PerArticle |
obj[] |
A list of the article items on this inventory task. The items are grouped first by their ArticleDefId, and then by the LocationId. |