Receive

This function allows you to receive goods into the system.

Tags: Receive, ReceivingOperation, ByUser, InOrder_Receive, ArticleItemStatus_Receive, ReceiveResponse, ReceivingResult, ReceiveError, ReceivedArticleItem_Receive

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/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	string(50)	Req.	Your username
Password	string(50)	Req.	Your password
Operation	ReceivingOperation	Req.	The operation object

ReceivingOperation
ArticleDefId	int	Ongoing WMS internal id of the article you wish to receive.
ReceivedByUser	ByUser	An element of type ByUser.
PalletItemId	int	If receiving onto a pallet item, this is the id of the pallet item.
NumberOfItems	decimal	The quantity which is being received.
Serial	string(128)	The serial number of the received item.
Batch	string(50)	The batch number of the received item.
Comment	string(400)	Comment. Will be stored on the article item.
Container	string(50)	Container number.
Length	decimal	Length.
Width	decimal	Width.
Height	decimal	Height.
Weight	decimal	Weight.
Volume	decimal
IsLockedByItemLock	boolean	true if you want to lock the received item, false otherwise.
ExpiryDate	dateTime	Expiry date.
InOrder	InOrder_Receive	An element of type InOrder_Receive.
ArticleItemStatus	ArticleItemStatus_Receive	An element of type ArticleItemStatus_Receive.
Location	string(50)	The name of the location where you want to receive the items to.

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.

InOrder_Receive
InOrderLineId	int		The id of the inorder line which you are receiving against.

ArticleItemStatus_Receive
ArticleItemStatusId	int		The id of the article item status that you want the item to have.

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>
    <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

ReceiveResponse
ReceiveResult	ReceivingResult

ReceivingResult
Errors	ReceiveError[]
Success	boolean	True if successful, false otherwise.
ReceivedArticleItem	ReceivedArticleItem_Receive	A ReceivedArticleItem object, which gives information about the item which was received.

ReceiveError
Message	string	Message explaining the error.
ErrorType	enum	The type of error: - UnknownError - LogonError - LocationNotFound - ArticleNotFound - ArticleIsDeleted - ArticleIsNotStockArticle - GoodsOwnerIsDeleted - InOrderIdNotFound - InOrderLineNotFound - InOrderLineIdMissMatch - NumberOfItemsToReceiveGreaterThanLeftToReceiveOnInOrder - PalletItemIdNotFound - ErrorWhileSaving - ReceivedByUserError - ArticleItemStatusNotFound - ArticleItemCategoryNotFound - InvalidNumberOfItems - InvalidFieldValues

ReceivedArticleItem_Receive
ArticleItemId	int	Ongoing system id for the received article item.
NumberOfItems	decimal	The received quantity.
LocationId	int	Ongoing system id for the location where the item was received.