Ongoing WMS logo

Ongoing WMS Developer

Receive

This function allows you to receive goods into the system.

Tags: Receive, Operation, ReceiveResult, ReceivedArticleItem, ReceiveError

Request XML

POST /xxx/Automation.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ongoingsystems.se/Automation/Receive"

<?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>
    <Receive xmlns="http://ongoingsystems.se/Automation">
      <UserName>string</UserName>
      <Password>string</Password>
      <Operation>
        <ArticleDefId>int</ArticleDefId>
        <ReceivedByUser>
          <UserName>string</UserName>
        </ReceivedByUser>
        <PalletItemId>int</PalletItemId>
        <NumberOfItems>decimal</NumberOfItems>
        <Serial>string</Serial>
        <Batch>string</Batch>
        <Comment>string</Comment>
        <Container>string</Container>
        <Length>decimal</Length>
        <Width>decimal</Width>
        <Height>decimal</Height>
        <Weight>decimal</Weight>
        <Volume>decimal</Volume>
        <IsLockedByItemLock>boolean</IsLockedByItemLock>
        <ExpiryDate>dateTime</ExpiryDate>
        <InOrder>
          <InOrderLineId>int</InOrderLineId>
        </InOrder>
        <ArticleItemStatus>
          <ArticleItemStatusId>int</ArticleItemStatusId>
        </ArticleItemStatus>
        <Location>string</Location>
      </Operation>
    </Receive>
  </soap:Body>
</soap:Envelope>
+

Request specification

Receive
UserName str(50) Req. Your username
Password str(50) Req. Your password
Operation object Req. An element of Operation.
Operation
ArticleDefId int Ongoing WMS internal id of the article you wish to receive.
ReceivedByUser object
> UserName str(50) The user who is doing the transaction.
PalletItemId int If receiving onto a pallet item, this is the id of the pallet item.
NumberOfItems dec The quantity which is being received.
Serial str(128) The serial number of the received item.
Batch str(50) The batch number of the received item.
Comment str(400) Comment. Will be stored on the article item.
Container str(50) Container number.
Length dec Length.
Width dec Width.
Height dec Height.
Weight dec Weight.
IsLockedByItemLock bool true if you want to lock the received item, false otherwise.
ExpiryDate dateTime Expiry date.
InOrder object
> InOrderLineId int The id of the inorder line which you are receiving against.
ArticleItemStatus object
> ArticleItemStatusId int The id of the article item status that you want the item to have.
Location str(50) The name of the location where you want to receive the items to.

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>
    <ReceiveResponse xmlns="http://ongoingsystems.se/Automation">
      <ReceiveResult>
        <Errors>
          <ReceiveError>
            <Message>string</Message>
            <ErrorType>UnknownError or LogonError or LocationNotFound or ArticleNotFound or ArticleIsDeleted or ArticleIsNotStockArticle or GoodsOwnerIsDeleted or InOrderIdNotFound or InOrderLineNotFound or InOrderLineIdMissMatch or NumberOfItemsToReceiveGreaterThanLeftToReceiveOnInOrder or PalletItemIdNotFound or ErrorWhileSaving or ReceivedByUserError or ArticleItemStatusNotFound or ArticleItemCategoryNotFound or InvalidNumberOfItems or InvalidFieldValues</ErrorType>
          </ReceiveError>
          <ReceiveError>
            <Message>string</Message>
            <ErrorType>UnknownError or LogonError or LocationNotFound or ArticleNotFound or ArticleIsDeleted or ArticleIsNotStockArticle or GoodsOwnerIsDeleted or InOrderIdNotFound or InOrderLineNotFound or InOrderLineIdMissMatch or NumberOfItemsToReceiveGreaterThanLeftToReceiveOnInOrder or PalletItemIdNotFound or ErrorWhileSaving or ReceivedByUserError or ArticleItemStatusNotFound or ArticleItemCategoryNotFound or InvalidNumberOfItems or InvalidFieldValues</ErrorType>
          </ReceiveError>
        </Errors>
        <Success>boolean</Success>
        <ReceivedArticleItem>
          <ArticleItemId>int</ArticleItemId>
          <NumberOfItems>decimal</NumberOfItems>
          <LocationId>int</LocationId>
        </ReceivedArticleItem>
      </ReceiveResult>
    </ReceiveResponse>
  </soap:Body>
</soap:Envelope>
+

Response specification

ReceiveResult
Errors object A list of ReceiveError objects
Success bool True if successful, false otherwise.
ReceivedArticleItem object A ReceivedArticleItem object, which gives information about the item which was received.
ReceivedArticleItem
ArticleItemId int Ongoing system id for the received article item.
NumberOfItems int The received quantity.
LocationId int Ongoing system id for the location where the item was received.
ReceiveError
Message str(*) Message explaining the error.
ErrorType string The type of error:
- UnknownError
- LogonError
- LocationNotFound
- ArticleNotFound
- ArticleIsDeleted
- ArticleIsNotStockArticle
- GoodsOwnerIsDeleted
- InOrderIdNotFound
- InOrderLineNotFound
- InOrderLineIdMissMatch
- NumberOfItemsToReceiveGreaterThanLeftToReceiveOnInOrder
- PalletItemIdNotFound
- ErrorWhileSaving
- ReceivedByUserError
- ArticleItemStatusNotFound
- ArticleItemCategoryNotFound
- InvalidNumberOfItems
- InvalidFieldValues