Ongoing WMS logo

Ongoing WMS Developer

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, Operation, RemoveByUser, RemoveArticleItemsFromOrderResult, PickAllocatedError

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>
            <AllowRemoveOfLessThanNumberOfItemsToRemove>boolean</AllowRemoveOfLessThanNumberOfItemsToRemove>
         </Operation>
      </RemoveArticleItemsFromOrder>
   </soap:Body>
</soap:Envelope>
+

Request specification

RemoveArticleItemsFromOrder
UserName str(50) Req. Your username
Password str(50) Req. Your password
Operation object Req. An element of type Operation.
Operation
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 object Req. An element of type RemoveByUser. Designates which user did the removing.
OriginalArticleItemId int Optional 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.
Location str(50) Optional The location to remove from.
OrderLineId int Optional 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.
Batch str(50) Optional 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.
AllowRemoveOfLessThanNumberOfItemsToRemove bool Optional Set to false if you want to get an error message if you try to remove more than is allocated to an order. If set to true it will still only remove at most the allocated number of items but no error will be caused. The result will contain the actual number of removed items. True is the default value.
RemoveByUser
UserName str(50) Req. The name of the user. Must be an actual user in Ongoing WMS. Will be set as the user that performed the removing.

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>
      <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</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</ErrorType>
               </RemoveArticleItemsFromOrderError>
            </Errors>
            <Success>boolean</Success>
            <RemovedNumberOfItems>decimal</RemovedNumberOfItems>
         </RemoveArticleItemsFromOrderResult>
      </RemoveArticleItemsFromOrderResponse>
   </soap:Body>
</soap:Envelope>
+

Response specification

RemoveArticleItemsFromOrderResult
Errors object A list of RemoveArticleItemsFromOrderError objects
Success bool True if successful, false otherwise.
RemovedNumberOfItems decimal Confirmation of how many items that were removed.
RemoveArticleItemsFromOrderError
Message str(*) Message explaining the error.
ErrorType string The type of error:
  • UnknownError
  • LogonError
  • LocationNotFound
  • ArticleNotFound
  • ArticleNotOnOrder
  • GoodsOwnerIsDeleted
  • OrderIdNotFound
  • OrderLineIdMissMatch
  • NumberOfItemsToRemoveGreaterThanOnOrder
  • ErrorWhileSaving
  • RemoveByUserError
  • NothingFoundToRemoveFromOrder