RemoveArticleItemsFromOrder
This API call allows you to remove allocated articles from orders.
A use case when it can be used is when the order cannot be picked, e.g. if some of the allocated items are missing. Then they need to be removed from the order before it is possible to adjust the stock balance to remove them.
Tags: RemoveArticleItemsFromOrder, RemoveArticleItemsFromOrderOperation, ByUser, RemoveArticleItemsFromOrderResponse, RemoveArticleItemsFromOrderResult, RemoveArticleItemsFromOrderError
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/RemoveArticleItemsFromOrder"
<?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>
<RemoveArticleItemsFromOrder xmlns="http://ongoingsystems.se/Automation">
<UserName>string</UserName>
<Password>string</Password>
<Operation>
<OrderId>int</OrderId>
<ArticleDefId>int</ArticleDefId>
<NumberOfItemsToRemove>decimal</NumberOfItemsToRemove>
<RemoveByUser>
<UserName>string</UserName>
</RemoveByUser>
<OriginalArticleItemId>int</OriginalArticleItemId>
<OrderLineId>int</OrderLineId>
<Location>string</Location>
<Batch>string</Batch>
<AllowRemoveLessThanNumberOfItemsToRemove>boolean</AllowRemoveLessThanNumberOfItemsToRemove>
<ComputerName>string</ComputerName>
</Operation>
</RemoveArticleItemsFromOrder>
</soap:Body>
</soap:Envelope>
Request specification
RemoveArticleItemsFromOrder |
UserName |
string(50) |
Req. |
Your username |
Password |
string(50) |
Req. |
Your password |
Operation |
RemoveArticleItemsFromOrderOperation |
Req. |
The operation object |
RemoveArticleItemsFromOrderOperation |
OrderId |
int |
Req. |
The order id of the order to remove from. |
ArticleDefId |
int |
Req. |
The article id of the article to remove. |
NumberOfItemsToRemove |
decimal |
Req. |
The number of items to remove. |
RemoveByUser |
ByUser |
Req. |
An element of type RemoveByUser. Designates which user did the removing. |
OriginalArticleItemId |
int |
|
The original article item id of an article item. Used to specify a specific article item to remove. A use case for this is when you want to remove a specific serial number from an order. |
OrderLineId |
int |
|
The order line id of an order line. Used if you want to specify which order line to remove from. If left empty, Ongoing WMS will match to an order line with the specified article. |
Location |
string(50) |
|
The location to remove from. |
Batch |
string(50) |
|
Filter by batch. If multiple batches of an article are allocated this will specify which batch to remove. Useful when there is need to track specific batches. |
AllowRemoveLessThanNumberOfItemsToRemove |
boolean |
|
|
ComputerName |
string(100) |
|
Name of a computer defined in the system. Used when deciding which printer to print on. |
ByUser |
UserName |
string(50) |
Req. |
The name of the user. Must be an actual user in Ongoing WMS. Will be set as the user that performed the packing. |
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>
<RemoveArticleItemsFromOrderResponse xmlns="http://ongoingsystems.se/Automation">
<RemoveArticleItemsFromOrderResult>
<Errors>
<RemoveArticleItemsFromOrderError>
<Message>string</Message>
<ErrorType>UnknownError or LogonError or LocationNotFound or ArticleNotFound or ArticleNotOnOrder or GoodsOwnerIsDeleted or OrderIdNotFound or OrderLineIdMissMatch or ErrorWhileSaving or RemoveByUserError or NumberOfItemsToRemoveGreaterThanOnOrder or NothingFoundToRemoveFromOrder or InvalidNumberOfItemsToRemove</ErrorType>
</RemoveArticleItemsFromOrderError>
<RemoveArticleItemsFromOrderError>
<Message>string</Message>
<ErrorType>UnknownError or LogonError or LocationNotFound or ArticleNotFound or ArticleNotOnOrder or GoodsOwnerIsDeleted or OrderIdNotFound or OrderLineIdMissMatch or ErrorWhileSaving or RemoveByUserError or NumberOfItemsToRemoveGreaterThanOnOrder or NothingFoundToRemoveFromOrder or InvalidNumberOfItemsToRemove</ErrorType>
</RemoveArticleItemsFromOrderError>
</Errors>
<Success>boolean</Success>
<RemovedNumberOfItems>decimal</RemovedNumberOfItems>
</RemoveArticleItemsFromOrderResult>
</RemoveArticleItemsFromOrderResponse>
</soap:Body>
</soap:Envelope>
Response specification
RemoveArticleItemsFromOrderResponse |
RemoveArticleItemsFromOrderResult |
RemoveArticleItemsFromOrderResult |
|
RemoveArticleItemsFromOrderResult |
Errors |
RemoveArticleItemsFromOrderError[] |
A list of RemoveArticleItemsFromOrderError objects |
Success |
boolean |
True if successful, false otherwise. |
RemovedNumberOfItems |
decimal |
Confirmation of how many items that were removed. |
RemoveArticleItemsFromOrderError |
Message |
string |
Message explaining the error. |
ErrorType |
enum |
The type of error: - UnknownError
- LogonError
- LocationNotFound
- ArticleNotFound
- ArticleNotOnOrder
- GoodsOwnerIsDeleted
- OrderIdNotFound
- OrderLineIdMissMatch
- NumberOfItemsToRemoveGreaterThanOnOrder
- ErrorWhileSaving
- RemoveByUserError
- NothingFoundToRemoveFromOrder
|