Receive
This function allows you to receive goods into the system.
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>
<NewPalletItem>
<PalletType>
<PalletTypeCode>string</PalletTypeCode>
<PalletTypeName>string</PalletTypeName>
<PalletTypeId>int</PalletTypeId>
<Identification>PalletTypeId or PalletTypeCode or PalletTypeName</Identification>
</PalletType>
<LabelId>string</LabelId>
<Serial>string</Serial>
<Comment>string</Comment>
<Weight>decimal</Weight>
<Volume>decimal</Volume>
<Length>decimal</Length>
<Width>decimal</Width>
<Height>decimal</Height>
<LoadMeters>decimal</LoadMeters>
<ParentPalletItemId>int</ParentPalletItemId>
</NewPalletItem>
<NumberOfItems>decimal</NumberOfItems>
<Serial>string</Serial>
<Batch>string</Batch>
<Comment>string</Comment>
<Container>string</Container>
<FreeText1>string</FreeText1>
<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 an existing pallet item, this is the id of the pallet item. | |
| NewPalletItem | CreateReceivePalletItemOperation | If receiving onto a new pallet item, this contains information about 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. | |
| FreeText1 | string(100) | Freetext 1 | |
| 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. |
| CreateReceivePalletItemOperation | |||
|---|---|---|---|
| PalletType | CreatePalletItemPalletTypeOperation | The pallet type of the pallet item to create. | |
| LabelId | string(30) | The pallet item label. Usually SSCC or some other kind of serial number. | |
| Serial | string(100) | Secondary serial number. It is usually preferred to use LabelId. | |
| Comment | string(300) | An optional comment. | |
| Weight | decimal | The weight of the pallet item in kilograms (Kg). | |
| Volume | decimal | The volume of the pallet item in cubic meters (m3). | |
| Length | decimal | The Length of the pallet item in meters (m). | |
| Width | decimal | The Width of the pallet item in meters (m). | |
| Height | decimal | The Height of the pallet item in meters (m). | |
| LoadMeters | decimal | The load meters of the pallet item. | |
| ParentPalletItemId | int | The pallet item id of the parent of this pallet item. Can be used for e.g. packages that are being placed on a pallet. | |
| 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. | |
| CreatePalletItemPalletTypeOperation | |||
|---|---|---|---|
| PalletTypeCode | string | ||
| PalletTypeName | string | ||
| PalletTypeId | int | ||
| Identification | enum | An element of type CreatePalletItemPalletTypeIdentification. | |
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>
<ReceivedPalletItem>
<PalletItemId>int</PalletItemId>
</ReceivedPalletItem>
</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. |
| ReceivedPalletItem | ReceivedArticleItem_PalletItem | Information about the pallet item that the article item was received on. |
| ReceivedArticleItem_PalletItem | ||
|---|---|---|
| PalletItemId | int | Ongoing system id for the pallet item where the item was received. |