GetMovements
This function lets you retrieve information about stock movements. By "movement" we mean when an item physically moves from one warehouse location to another location.
Tags: GetMovements, GetMovementsQuery, GetMovementsResponse, GetMovementsResult, Movement, GetMovementsErrorResult, MovementArticle
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/GetMovements"
<?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>
<GetMovements xmlns="http://ongoingsystems.se/Automation">
<UserName>string</UserName>
<Password>string</Password>
<Query>
<FromLocation>string</FromLocation>
<ToLocation>string</ToLocation>
<MoveTimeFrom>dateTime</MoveTimeFrom>
<MoveTimeTo>dateTime</MoveTimeTo>
<ArticleDefIds>
<int>int</int>
<int>int</int>
</ArticleDefIds>
<GoodsOwnerIds>
<int>int</int>
<int>int</int>
</GoodsOwnerIds>
<FromWarehouseId>int</FromWarehouseId>
<ToWarehouseId>int</ToWarehouseId>
<OnlyMovementsBetweenDifferentWarehouses>boolean</OnlyMovementsBetweenDifferentWarehouses>
<OnlyMovementsBetweenLockedForSaleAndNotLockedForSaleLocations>boolean</OnlyMovementsBetweenLockedForSaleAndNotLockedForSaleLocations>
</Query>
</GetMovements>
</soap:Body>
</soap:Envelope>
Request specification
GetMovements |
UserName |
string(50) |
Req. |
Your username |
Password |
string(50) |
Req. |
Your password |
Query |
GetMovementsQuery |
Req. |
The query object |
GetMovementsQuery |
FromLocation |
string(50) |
|
Only return stock movements from this location. |
ToLocation |
string(50) |
|
Only return stock movements to this location. |
MoveTimeFrom |
dateTime |
Req. |
Only return stock movements which happened after this time. |
MoveTimeTo |
dateTime |
|
Only return stock movements which happened before this time. |
ArticleDefIds |
int[] |
|
Only return stock movements for these particular articles. |
GoodsOwnerIds |
int[] |
|
Only return stock movements for these particular goods owners. |
FromWarehouseId |
int |
|
Only return stock movements from this warehouse. |
ToWarehouseId |
int |
|
Only return stock movements to this warehouse. |
OnlyMovementsBetweenDifferentWarehouses |
boolean |
|
Only return stock movements between warehouses. |
OnlyMovementsBetweenLockedForSaleAndNotLockedForSaleLocations |
boolean |
|
Only return movements where one of the locations is locked for sale and the other is not. |
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>
<GetMovementsResponse xmlns="http://ongoingsystems.se/Automation">
<GetMovementsResult>
<Movements>
<Movement>
<Article>
<ArticleDefId>int</ArticleDefId>
<ArticleNumber>string</ArticleNumber>
<ArticleName>string</ArticleName>
</Article>
<NumberOfItems>decimal</NumberOfItems>
<OriginalArticleItemId>int</OriginalArticleItemId>
<Serial>string</Serial>
<ExpiryDate>dateTime</ExpiryDate>
<InOrderId>int</InOrderId>
<Batch>string</Batch>
<InOrderNumber>string</InOrderNumber>
<MoveTime>dateTime</MoveTime>
<MovedByUserName>string</MovedByUserName>
<FromLocation>string</FromLocation>
<FromLocationTypeCode>string</FromLocationTypeCode>
<ToLocation>string</ToLocation>
<ToLocationTypeCode>string</ToLocationTypeCode>
<FromWarehouseId>int</FromWarehouseId>
<ToWarehouseId>int</ToWarehouseId>
<ArticleItemInLocationId>int</ArticleItemInLocationId>
<IsFromLocationLockedForSale>boolean</IsFromLocationLockedForSale>
<IsToLocationLockedForSale>boolean</IsToLocationLockedForSale>
</Movement>
<Movement>
<Article>
<ArticleDefId>int</ArticleDefId>
<ArticleNumber>string</ArticleNumber>
<ArticleName>string</ArticleName>
</Article>
<NumberOfItems>decimal</NumberOfItems>
<OriginalArticleItemId>int</OriginalArticleItemId>
<Serial>string</Serial>
<ExpiryDate>dateTime</ExpiryDate>
<InOrderId>int</InOrderId>
<Batch>string</Batch>
<InOrderNumber>string</InOrderNumber>
<MoveTime>dateTime</MoveTime>
<MovedByUserName>string</MovedByUserName>
<FromLocation>string</FromLocation>
<FromLocationTypeCode>string</FromLocationTypeCode>
<ToLocation>string</ToLocation>
<ToLocationTypeCode>string</ToLocationTypeCode>
<FromWarehouseId>int</FromWarehouseId>
<ToWarehouseId>int</ToWarehouseId>
<ArticleItemInLocationId>int</ArticleItemInLocationId>
<IsFromLocationLockedForSale>boolean</IsFromLocationLockedForSale>
<IsToLocationLockedForSale>boolean</IsToLocationLockedForSale>
</Movement>
</Movements>
<Error>
<ErrorType>FromDateOccursAfterToDate or Unknown or LogonError</ErrorType>
<Message>string</Message>
</Error>
<Success>boolean</Success>
</GetMovementsResult>
</GetMovementsResponse>
</soap:Body>
</soap:Envelope>
Response specification
GetMovementsResponse |
GetMovementsResult |
GetMovementsResult |
|
GetMovementsResult |
Movements |
Movement[] |
List of movements. |
Error |
GetMovementsErrorResult |
An element of type GetMovementsErrorResult. |
Success |
boolean |
|
Movement |
Article |
MovementArticle |
Contains information about the moved article (article number, article name, etc). |
NumberOfItems |
decimal |
Number of items which were moved. |
OriginalArticleItemId |
int |
Original article item id. |
Serial |
string(128) |
Serial number of the moved item. |
ExpiryDate |
dateTime |
Expiry date of the moved item. |
InOrderId |
int |
The id of the inorder which the item belongs to (if the item was received on an inorder). |
Batch |
string(50) |
Batch number of the moved item. |
InOrderNumber |
string(50) |
The inorder number of the inorder which the item belongs to (if the item was received on an inorder). |
MoveTime |
dateTime |
The time when the move was performed. |
MovedByUserName |
string(50) |
Username of the user who performed the move. |
FromLocation |
string(50) |
The location the items were moved from. |
FromLocationTypeCode |
string(50) |
The location type code of the location which the items were moved from. |
ToLocation |
string(50) |
The location the items were moved to. |
ToLocationTypeCode |
string(50) |
The location type code of the location which the items were moved to. |
FromWarehouseId |
int |
The warehouse id which the items were moved from. |
ToWarehouseId |
int |
The warehouse id which the items were moved to. |
ArticleItemInLocationId |
int |
The movement transaction id. |
IsFromLocationLockedForSale |
boolean |
True if the location the items were moved from is locked for sale. |
IsToLocationLockedForSale |
boolean |
True if the location the items were moved to. |
GetMovementsErrorResult |
ErrorType |
enum |
An element of type GetMovementsErrorType. |
Message |
string |
|
MovementArticle |
ArticleDefId |
int |
|
ArticleNumber |
string |
|
ArticleName |
string |
|