UpdateArticleItems
Each article (SKU) in Ongoing WMS has zero or more article items. The article items represent what is in stock at the warehouse (for more information about article items, see this article). UpdateArticleItems allows you to update the status of one or more article items.
Request XML
POST /xxx/service.asmx HTTP/1.1
Host: api.ongoingsystems.se
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ongoingsystems.se/WSI/UpdateArticleItems"
<?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>
<UpdateArticleItems xmlns="http://ongoingsystems.se/WSI">
<GoodsOwnerCode>string</GoodsOwnerCode>
<UserName>string</UserName>
<Password>string</Password>
<Operation>
<Identification>
<ArticleNumber>string</ArticleNumber>
<ArticleSystemId>int</ArticleSystemId>
<OriginalArticleItemId>int</OriginalArticleItemId>
<ArticleItemId>int</ArticleItemId>
<ArticleItemStatusId>int</ArticleItemStatusId>
<Batch>string</Batch>
<Serial>string</Serial>
<StockStatus>IsInStock or IsInStockOrIsAdvised</StockStatus>
</Identification>
<NumberOfItemsToUpdate>decimal</NumberOfItemsToUpdate>
<UpdateArticleItemStatus>
<ArticleItemStatusCode>string</ArticleItemStatusCode>
<ArticleItemStatusId>int</ArticleItemStatusId>
</UpdateArticleItemStatus>
<UpdateArticleItemCategory>
<ArticleItemCategoryCode>string</ArticleItemCategoryCode>
<ArticleItemCategoryId>int</ArticleItemCategoryId>
</UpdateArticleItemCategory>
<UpdateArticleItemLock>
<IsLockedByItemLock>bool</IsLockedByItemLock>
</UpdateArticleItemLock>
<UpdateArticleItemPrice>
<ArticleItemPrice>decimal</ArticleItemPrice>
</UpdateArticleItemPrice>
</Operation>
</UpdateArticleItems>
</soap:Body>
</soap:Envelope>
Request specification
UpdateArticleItems | |||
---|---|---|---|
GoodsOwnerCode | str(400) | Req. | The name/code of your client |
UserName | str(50) | Req. | Your username |
Password | str(50) | Req. | Your password |
Operation | object | Req. | The operation object |
Operation | |||
---|---|---|---|
Identification | object | Required | This object tells the system which article items you want to update. For instance, you can update all article items which have the same batch. You have to specify at least one identifier. See Identification. |
NumberOfItemsToUpdate | decimal | If specified, this is the maximum quantity which you want to change. If you don't specify this field, the system will change all article items which match your filter. | |
UpdateArticleItemStatus | object | The new article item status of the items which match your filter. See UpdateArticleItemStatus. | |
UpdateArticleItemCategory | object | The new article item category of the items which match your filter. See UpdateArticleItemCategory. | |
UpdateArticleItemLock | object | Allows you to lock or unlock the items which match your filter. See UpdateArticleItemLock. Note that this lock specifically refers to the item lock. There are other ways of locking items (for instance, by placing them in a locked location) and those types of locks will not be affected by changing the item lock. | |
UpdateArticleItemPrice | object | The new article item price of the items which match your filter. See UpdateArticleItemPrice. |
Identification | |||
---|---|---|---|
ArticleNumber | str(100) | The article number whose items you want to update. | |
ArticleSystemId | int | The article system id of the article whose items you want to update. | |
OriginalArticleItemId | int | Only update article items which have the specified OriginalArticleItemId. | |
ArticleItemId | int | Only update this particular ArticleItemId. | |
ArticleItemStatusId | int | Only update article items which have this status id. | |
Batch | str(50) | The batch number of the article items which you want to update. | |
Serial | str(128) | The serial number of the article items which you want to update. | |
StockStatus | enum | This value must be either IsInStock or IsInStockOrIsAdvised. If IsInStock, then the system will only update article items which are in stock. If IsInStockOrIsAdvised, then the system will update article items which are either in stock or advised (this is the default behavior). |
UpdateArticleItemStatus | |||
---|---|---|---|
ArticleItemStatusCode | str(50) | The new article item status code for the items. | |
ArticleItemStatusId | int | The new article item status id for the items. |
UpdateArticleItemStatus | |||
---|---|---|---|
ArticleItemCategoryCode | str(100) | The new article item category code for the items. | |
ArticleItemCategoryId | int | The new article item category id for the items. |
UpdateArticleItemLock | |||
---|---|---|---|
IsLockedByItemLock | bool | Whether or not the items are item locked. |
UpdateArticleItemPrice | |||
---|---|---|---|
ArticleItemPrice | decimal | The new article item price for the items. |
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>
<UpdateArticleItemsResponse xmlns="http://ongoingsystems.se/WSI">
<UpdateArticleItemsResult>
<Errors>
<UpdateArticleItemsResultError>
<Message>string</Message>
<ErrorType>UnknownError or LogonError or NoArticleItemsFound or ArticleNotFound or ErrorUpdating or InvalidIdentification or ArticleItemStatusNotFound or NoUpdateOperationSpecified or ArticleItemDivideFailed or ArticleItemCategoryNotFound</ErrorType>
</UpdateArticleItemsResultError>
<UpdateArticleItemsResultError>
<Message>string</Message>
<ErrorType>UnknownError or LogonError or NoArticleItemsFound or ArticleNotFound or ErrorUpdating or InvalidIdentification or ArticleItemStatusNotFound or NoUpdateOperationSpecified or ArticleItemDivideFailed or ArticleItemCategoryNotFound</ErrorType>
</UpdateArticleItemsResultError>
</Errors>
<UpdatedArticleItems>
<UpdatedArticleItem>
<Article xsi:nil="true" />
<ArticleItemId>int</ArticleItemId>
<OriginalArticleItemId>int</OriginalArticleItemId>
<Serial>string</Serial>
<Batch>string</Batch>
<ArticleItemStatusId>int</ArticleItemStatusId>
<NumberOfItems>decimal</NumberOfItems>
<ArticleItemCategoryId>int</ArticleItemCategoryId>
<IsLockedByItemLock>bool</IsLockedByItemLock>
<ArticleItemPrice>decimal</ArticleItemPrice>
</UpdatedArticleItem>
<UpdatedArticleItem>
<Article xsi:nil="true" />
<ArticleItemId>int</ArticleItemId>
<OriginalArticleItemId>int</OriginalArticleItemId>
<Serial>string</Serial>
<Batch>string</Batch>
<ArticleItemStatusId>int</ArticleItemStatusId>
<NumberOfItems>decimal</NumberOfItems>
<ArticleItemCategoryId>int</ArticleItemCategoryId>
<IsLockedByItemLock>bool</IsLockedByItemLock>
<ArticleItemPrice>decimal</ArticleItemPrice>
</UpdatedArticleItem>
</UpdatedArticleItems>
<Success>bool</Success>
</UpdateArticleItemsResult>
</UpdateArticleItemsResponse>
</soap:Body>
</soap:Envelope>
Response specification
UpdateArticleItemsResult | ||
---|---|---|
Errors | object | A list of UpdateArticleItemsResultError objects |
Success | bool | True if successful, false otherwise. |
UpdatedArticleItems | object | An list of objects of type UpdatedArticleItem, telling you which article items were updated. |
UpdateArticleItemsResultError | ||
---|---|---|
Message | str(*) | Message explaining the error. |
ErrorType | string |
The type of error: - UnknownError - LogonError - NoArticleItemsFound - ArticleNotFound - ErrorUpdating - InvalidIdentification - ArticleItemStatusNotFound - NoUpdateOperationSpecified - ArticleItemDivideFailed - ArticleItemCategoryNotFound |
UpdatedArticleItem | ||
---|---|---|
Article | object | Information about the article. |
ArticleItemId | int | Article item id. |
OriginalArticleItemId | int | Original article item id. |
Serial | str(128) | Serial number. |
Batch | str(50) | Batch number. |
ArticleItemStatusId | int | Article item status id. |
NumberOfItems | decimal | The quantity which this article item represents. |
ArticleItemCategoryId | int | Article item category id. |
IsLockedByItemLock | bool | Whether or note the item is locked. |
ArticleItemPrice | decimal | The article item price |