GetMovementArticleItemsByQuery
Returns all movement article items which match a particular query.
Tags: GetMovementArticleItemsByQuery, Query, SpecialFilters, Paging, GetMovementArticleItemsByQueryResponse, GetMovementArticleItemsByQueryResult, MovementArticleItemInfo, ArticleInfo, ArticleInfoAlternativeBarcode, ArticleInfoAlternativeBarcodeType, OrderInfo, PickOrderInfo, PickOrderPickingCartInfo, GetMovementArticleItemsOrderLineInfo, GetMovementArticleItemsOrderConsigneeInfo, MovementArticleItemType
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/GetMovementArticleItemsByQuery"
<?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>
<GetMovementArticleItemsByQuery xmlns="http://ongoingsystems.se/Automation">
<UserName>string</UserName>
<Password>string</Password>
<Query>
<FromLocations>
<string>string</string>
<string>string</string>
</FromLocations>
<ToLocations>
<string>string</string>
<string>string</string>
</ToLocations>
<OrderId>int</OrderId>
<ArticleItemId>int</ArticleItemId>
<ArticleDefId>int</ArticleDefId>
<GoodsOwnerId>int</GoodsOwnerId>
<SpecialFilters>
<OnlyGetMovementArticleItemsToBeHandled>boolean</OnlyGetMovementArticleItemsToBeHandled>
<OnlyGetMovementArticleItemsWithType>boolean</OnlyGetMovementArticleItemsWithType>
</SpecialFilters>
<Paging>
<MaxRowsToGet>int</MaxRowsToGet>
<MaxWorkOrdersToGet>int</MaxWorkOrdersToGet>
</Paging>
</Query>
</GetMovementArticleItemsByQuery>
</soap:Body>
</soap:Envelope>
+
Request specification
GetMovementArticleItemsByQuery |
UserName |
str(50) |
Req. |
Your username. |
Password |
str(50) |
Req. |
Your password. |
Query |
object |
Req. |
A Query object |
Query |
FromLocations |
str[] |
|
Filter for movement article items being moved from these locations |
ToLocations |
str[] |
|
Filter for movement article items being moved to these locations |
OrderId |
int |
|
Filter for movement article items belonging to this order id |
ArticleItemId |
int |
|
Filter for movement article items for this article item |
ArticleDefId |
int |
|
Filter for movement article items for this article |
GoodsOwnerId |
int |
|
Filter for movement article items for this goodsowner |
SpecialFilters |
object |
|
A SpecialFilters object |
Paging |
object |
|
A Paging object |
SpecialFilters |
OnlyGetMovementArticleItemsToBeHandled |
bool |
|
Filter for article items which have been marked as "to be handled" by MovementArticleItemHandled |
OnlyGetMovementArticleItemsWithType |
bool |
|
Filter for movement article items where the type of the movement article item is not null |
Paging |
MaxRowsToGet |
int |
|
Max number of article items to return in response. Note: Filter may not be used in conjunction with MaxWorkOrdersToGet |
MaxWorkOrdersToGet |
int |
|
Max number of work orders to return in response. Note: Filter may not be used in conjunction with MaxRowsToGet |
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>
<GetMovementArticleItemsByQueryResponse xmlns="http://ongoingsystems.se/Automation">
<GetMovementArticleItemsByQueryResult>
<Success>boolean</Success>
<Message>string</Message>
<MovementArticleItems>
<MovementArticleItemInfo>
<Article>
<ArticleName>string</ArticleName>
<ArticleNumber>string</ArticleNumber>
<ArticleDefId>int</ArticleDefId>
<GoodsOwnerName>string</GoodsOwnerName>
<GoodsOwnerId>int</GoodsOwnerId>
<ArticleGroupCode>string</ArticleGroupCode>
<ProductCode>string</ProductCode>
<BarCode>string</BarCode>
<ArticleUnitCode>string</ArticleUnitCode>
<Description>string</Description>
<LinkToPicture>string</LinkToPicture>
<Weight>decimal</Weight>
<Length>decimal</Length>
<Width>decimal</Width>
<Height>decimal</Height>
<AlternativeBarcodes>
<ArticleInfoAlternativeBarcode>
<BarCode>string</BarCode>
<QuantityPerBarcode>decimal</QuantityPerBarcode>
<Type>
<Name>string</Name>
<Code>string</Code>
</Type>
</ArticleInfoAlternativeBarcode>
<ArticleInfoAlternativeBarcode>
<BarCode>string</BarCode>
<QuantityPerBarcode>decimal</QuantityPerBarcode>
<Type>
<Name>string</Name>
<Code>string</Code>
</Type>
</ArticleInfoAlternativeBarcode>
</AlternativeBarcodes>
</Article>
<Order>
<OrderNumber>string</OrderNumber>
<OrderId>int</OrderId>
<WayOfDelivery>string</WayOfDelivery>
<PickOrder>
<PickOrderId>int</PickOrderId>
<BinIndex>int</BinIndex>
<PickingCart>
<PickingCartId>int</PickingCartId>
<PickingCartName>string</PickingCartName>
</PickingCart>
</PickOrder>
<FreeText1>string</FreeText1>
<FreeText2>string</FreeText2>
<FreeText3>string</FreeText3>
<WarehouseInstruction>string</WarehouseInstruction>
<OrderLine>
<WarehouseInstruction>string</WarehouseInstruction>
</OrderLine>
<Consignee>
<CustomerNumber>string</CustomerNumber>
<Name>string</Name>
</Consignee>
</Order>
<Serial>string</Serial>
<NumberOfItems>decimal</NumberOfItems>
<ArticleItemId>int</ArticleItemId>
<MovementArticleItemId>int</MovementArticleItemId>
<WorkOrderId>int</WorkOrderId>
<Batch>string</Batch>
<FromLocation>string</FromLocation>
<ToLocation>string</ToLocation>
<OriginalArticleItemId>int</OriginalArticleItemId>
<SortIndex>int</SortIndex>
<MovementArticleItemType>
<code>string</code>
<Name>string</Name>
</MovementArticleItemType>
</MovementArticleItemInfo>
<MovementArticleItemInfo>
<Article>
<ArticleName>string</ArticleName>
<ArticleNumber>string</ArticleNumber>
<ArticleDefId>int</ArticleDefId>
<GoodsOwnerName>string</GoodsOwnerName>
<GoodsOwnerId>int</GoodsOwnerId>
<ArticleGroupCode>string</ArticleGroupCode>
<ProductCode>string</ProductCode>
<BarCode>string</BarCode>
<ArticleUnitCode>string</ArticleUnitCode>
<Description>string</Description>
<LinkToPicture>string</LinkToPicture>
<Weight>decimal</Weight>
<Length>decimal</Length>
<Width>decimal</Width>
<Height>decimal</Height>
<AlternativeBarcodes>
<ArticleInfoAlternativeBarcode>
<BarCode>string</BarCode>
<QuantityPerBarcode>decimal</QuantityPerBarcode>
<Type>
<Name>string</Name>
<Code>string</Code>
</Type>
</ArticleInfoAlternativeBarcode>
<ArticleInfoAlternativeBarcode>
<BarCode>string</BarCode>
<QuantityPerBarcode>decimal</QuantityPerBarcode>
<Type>
<Name>string</Name>
<Code>string</Code>
</Type>
</ArticleInfoAlternativeBarcode>
</AlternativeBarcodes>
</Article>
<Order>
<OrderNumber>string</OrderNumber>
<OrderId>int</OrderId>
<WayOfDelivery>string</WayOfDelivery>
<PickOrder>
<PickOrderId>int</PickOrderId>
<BinIndex>int</BinIndex>
<PickingCart>
<PickingCartId>int</PickingCartId>
<PickingCartName>string</PickingCartName>
</PickingCart>
</PickOrder>
<FreeText1>string</FreeText1>
<FreeText2>string</FreeText2>
<FreeText3>string</FreeText3>
</Order>
<Serial>string</Serial>
<NumberOfItems>decimal</NumberOfItems>
<ArticleItemId>int</ArticleItemId>
<MovementArticleItemId>int</MovementArticleItemId>
<WorkOrderId>int</WorkOrderId>
<Batch>string</Batch>
<FromLocation>string</FromLocation>
<ToLocation>string</ToLocation>
<OriginalArticleItemId>int</OriginalArticleItemId>
<SortIndex>int</SortIndex>
<MovementArticleItemType>
<Code>string</Code>
<Name>string</Name>
</MovementArticleItemType>
</MovementArticleItemInfo>
</MovementArticleItems>
</GetMovementArticleItemsByQueryResult>
</GetMovementArticleItemsByQueryResponse>
</soap:Body>
</soap:Envelope>
+
Response specification
GetMovementArticleItemsByQueryResponse |
GetArticleItemsByQueryResult |
obj |
A GetMovementArticleItemsByQueryResult object |
GetMovementArticleItemsByQueryResult |
Success |
bool |
True if the call succeeded, false otherwise |
Message |
str |
If the call failed, this field contains the error message |
MovementArticleItems |
MovementArticleItemInfo[] |
The movement article items which matched the filter, as a list of MovementArticleItemInfo objects |
MovementArticleItemInfo |
Article |
object |
An ArticleInfo object, containing information about the article definition |
Order |
object |
An OrderInfo object, containing information about the order which the movement article item is tied to |
Serial |
str(128) |
The serial number of the article item |
NumberOfItems |
dec |
The quantity of the article item |
ArticleItemId |
int |
The internal system id of the article item |
MovementArticleItemId |
int |
The internal system id of the movement article item |
WorkOrderId |
int |
The work order id |
Batch |
str(50) |
The batch number of the article item |
FromLocation |
str(50) |
The name of the location where the article item is being moved from |
ToLocation |
str(50) |
The name of the location where the article item is being moved to |
OriginalArticleItemId |
int |
The original article item id of this item. If an article item has been created by splitting a previously existing article item, this field will tell you the id of the original article item. |
SortIndex |
int |
Sort index of the movement article item |
MovementArticleItemType |
object |
An MovementArticleItemType object, containing information about the items movement article item type |
ArticleInfo |
ArticleName |
str(200) |
The article name |
ArticleNumber |
str(100) |
The article number |
ArticleDefId |
int |
The internal system id of the article |
GoodsOwnerName |
str(400) |
The name of the goodsowner to which the article belongs |
GoodsOwnerId |
int |
The internal system id of the goodsowner to which the article belongs |
ArticleGroupCode |
str(100) |
The code of the group to which the article belongs |
ProductCode |
str(200) |
Product code |
BarCode |
str(100) |
The barcode/EAN of the article |
ArticleUnitCode |
str(50) |
The unit code of the article (e.g. "pcs") |
Description |
str(3000) |
The article description |
LinkToPicture |
str(300) |
An URL to an image of the article |
Weight |
decimal |
The article weight |
Length |
decimal |
The article lenght |
Width |
decimal |
The article width |
Height |
decimal |
The article height |
AlternativeBarcodes |
ArticleInfoAlternativeBarcode[] |
Alternative barcodes for this article. Used for defining different package sizes or just defining extra barcodes to identify an article. Contains ArticleInfoAlternativeBarcode objects |
ArticleInfoAlternativeBarcode |
Barcode |
str(100) |
The alternative barcode. |
QuantityPerBarcode |
decimal |
The package size if this is used to define a package. |
Type |
object |
An ArticleInfoAlternativeBarcodeType object. |
ArticleInfoAlternativeBarcodeType |
Name |
str(300) |
The name of the type. |
Code |
str(300) |
The code of the type. |
OrderInfo |
OrderNumber |
str(50) |
The order number. Same as GoodsOwnerOrderNumber in ProcessOrder |
OrderId |
int |
The internal system id of the order |
WayOfDelivery |
str(50) |
The way of delivery of the order |
PickOrder |
Object |
A PickOrderInfo object, containing information about the pick order which the movement article item is tied to |
FreeText1 |
str(300) |
Free text 1 |
FreeText2 |
str(50) |
Free text 2 |
FreeText3 |
str(50) |
Free text 3 |
WarehouseInstruction |
str(500) |
Warehouse instruction |
OrderLine |
Object |
A GetMovementArticleItemsOrderLineInfo object, containing information about the order line which the movement article item is tied to |
Consignee |
Object |
A GetMovementArticleItemsOrderConsigneeInfo object, containing information about the order consignee which the movement article item is tied to |
PickOrderInfo |
PickOrderId |
int |
The internal system id of the pick order |
BinIndex |
int |
The index of the bin/compartment on the picking cart to which the pick order is assigned |
PickingCart |
Object |
A PickOrderPickingCartInfo object, containing information about the picking cart which the pick order is tied to |
PickOrderPickingCartInfo |
PickingCartId |
int |
The internal system id of the picking cart |
PickingCartName |
string |
The name of the picking cart |
GetMovementArticleItemsOrderLineInfo |
WarehouseInstruction |
str(300) |
Warehouse instruction on the order line |
GetMovementArticleItemsOrderConsigneeInfo |
CustomerNumber |
str(50) |
Customer number |
Name |
str(200) |
Name of the consignee |
MovementArticleItemType |
Code |
str(50) |
Identifier for the movement article item type |
Name |
str(50) |
Full name for the movement article item type |