GetOrderArticleItemsByQuery
This call allows you to query for information about article items which have been picked on orders. The call will return all article items matching the specified query, and for each article item it will also give information about the order which the article item was picked on.
The difference between this call and GetArticleItemsByQuery, is that only picked article items will be returned in this call.
Tags: GetOrderArticleItemsByQuery, GetOrderArticleItemsQuery, GetOrderArticleItemsByQueryResponse, GetOrderArticleItemsResult, OrderArticleItemInfo, ArticleInfo, OrderArticleItemInfoOrderInfo, ArticleInfoAlternativeBarcode, ArticleClassInfoAutomation, OrderArticleItemInfoConsignee, ArticleInfoAlternativeBarcodeType
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/GetOrderArticleItemsByQuery"
<?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>
<GetOrderArticleItemsByQuery xmlns="http://ongoingsystems.se/Automation">
<UserName>string</UserName>
<Password>string</Password>
<Query>
<Locations>
<string>string</string>
<string>string</string>
</Locations>
<GoodsOwnerId>int</GoodsOwnerId>
<ArticleItemId>int</ArticleItemId>
<ArticleDefId>int</ArticleDefId>
<OnlyLiveGoodsOwners>boolean</OnlyLiveGoodsOwners>
<OrderStatusFrom>int</OrderStatusFrom>
<OrderStatusTo>int</OrderStatusTo>
<SerialNumber>string</SerialNumber>
<OrderPalletItemLabelId>string</OrderPalletItemLabelId>
<OrderId>int</OrderId>
</Query>
</GetOrderArticleItemsByQuery>
</soap:Body>
</soap:Envelope>
Request specification
GetOrderArticleItemsByQuery |
UserName |
string(50) |
Req. |
Your username |
Password |
string(50) |
Req. |
Your password |
Query |
GetOrderArticleItemsQuery |
Req. |
The query object |
GetOrderArticleItemsQuery |
Locations |
string[] |
|
Filter for article items in these locations |
GoodsOwnerId |
int |
|
Filter for article items belonging to this goods owner |
ArticleItemId |
int |
|
Filter for this particular article item |
ArticleDefId |
int |
|
Filter for this particular article |
OnlyLiveGoodsOwners |
boolean |
|
If true, only return article items belonging to goods owners which have been marked as "live" (i.e. goods owners which are not used for testing or training). |
OrderStatusFrom |
int |
|
Only return article items belonging to orders whose status are greater than or equal to this value |
OrderStatusTo |
int |
|
Only return article items belonging to orders whose status are less than or equal to this value |
SerialNumber |
string(128) |
|
Return article items whose serial number is equal to this value |
OrderPalletItemLabelId |
string(30) |
|
Return article items which have been placed in a pallet/package with the specified label id |
OrderId |
int |
|
Get article items from this order ID |
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>
<GetOrderArticleItemsByQueryResponse xmlns="http://ongoingsystems.se/Automation">
<GetOrderArticleItemsByQueryResult>
<Success>boolean</Success>
<Message>string</Message>
<ArticleItems>
<OrderArticleItemInfo>
<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>
<ArticleReturnHandlingComment>string</ArticleReturnHandlingComment>
<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>
<ArticleClasses>
<ArticleClass>
<Name>string</Name>
<Code>string</Code>
<Id>int</Id>
</ArticleClass>
<ArticleClass>
<Name>string</Name>
<Code>string</Code>
<Id>int</Id>
</ArticleClass>
</ArticleClasses>
<IsSerialNumberArticle>boolean</IsSerialNumberArticle>
<IsExpiryDateArticle>boolean</IsExpiryDateArticle>
</Article>
<OrderPalletItemLabelId>string</OrderPalletItemLabelId>
<Serial>string</Serial>
<Batch>string</Batch>
<NumberOfItems>decimal</NumberOfItems>
<ArticleItemId>int</ArticleItemId>
<Location>string</Location>
<OrderInfo>
<OrderId>int</OrderId>
<OrderNumber>string</OrderNumber>
<Consignee>
<Name>string</Name>
<CustomerGroupCode>string</CustomerGroupCode>
<CustomerGroupName>string</CustomerGroupName>
</Consignee>
<TransporterOrderNumber>string</TransporterOrderNumber>
<OrderLineId>int</OrderLineId>
<IsPacked>boolean</IsPacked>
<IsPicked>boolean</IsPicked>
<IsReturned>boolean</IsReturned>
</OrderInfo>
<OriginalArticleItemId>int</OriginalArticleItemId>
</OrderArticleItemInfo>
<OrderArticleItemInfo>
<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>
<ArticleReturnHandlingComment>string</ArticleReturnHandlingComment>
<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>
<ArticleClasses>
<ArticleClass>
<Name>string</Name>
<Code>string</Code>
<Id>int</Id>
</ArticleClass>
<ArticleClass>
<Name>string</Name>
<Code>string</Code>
<Id>int</Id>
</ArticleClass>
</ArticleClasses>
<IsSerialNumberArticle>boolean</IsSerialNumberArticle>
<IsExpiryDateArticle>boolean</IsExpiryDateArticle>
</Article>
<OrderPalletItemLabelId>string</OrderPalletItemLabelId>
<Serial>string</Serial>
<Batch>string</Batch>
<NumberOfItems>decimal</NumberOfItems>
<ArticleItemId>int</ArticleItemId>
<Location>string</Location>
<OrderInfo>
<OrderId>int</OrderId>
<OrderNumber>string</OrderNumber>
<Consignee>
<Name>string</Name>
<CustomerGroupCode>string</CustomerGroupCode>
<CustomerGroupName>string</CustomerGroupName>
</Consignee>
<TransporterOrderNumber>string</TransporterOrderNumber>
<OrderLineId>int</OrderLineId>
<IsPacked>boolean</IsPacked>
<IsPicked>boolean</IsPicked>
<IsReturned>boolean</IsReturned>
</OrderInfo>
<OriginalArticleItemId>int</OriginalArticleItemId>
</OrderArticleItemInfo>
</ArticleItems>
</GetOrderArticleItemsByQueryResult>
</GetOrderArticleItemsByQueryResponse>
</soap:Body>
</soap:Envelope>
Response specification
GetOrderArticleItemsByQueryResponse |
GetOrderArticleItemsByQueryResult |
GetOrderArticleItemsResult |
|
GetOrderArticleItemsResult |
Success |
boolean |
True if the call succeeded, false otherwise |
Message |
string |
If the call failed, this field contains the error message |
ArticleItems |
OrderArticleItemInfo[] |
The article items which matched the filter, as a list of OrderArticleItemInfo objects |
OrderArticleItemInfo |
Article |
ArticleInfo |
An ArticleInfo object, containing information about the article definition |
OrderPalletItemLabelId |
string(30) |
Label ID |
Serial |
string(128) |
The serial number of the article item |
Batch |
string(50) |
The batch number of the article item |
NumberOfItems |
decimal |
The quantity |
ArticleItemId |
int |
The internal system id of the article item |
Location |
string(50) |
Name of the current location where the article item is placed |
OrderInfo |
OrderArticleItemInfoOrderInfo |
An OrderInfo object, containing information about the order which the article item belongs 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. |
ArticleInfo |
ArticleName |
string(200) |
The article name |
ArticleNumber |
string(100) |
The article number |
ArticleDefId |
int |
The internal system id of the article |
GoodsOwnerName |
string(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 |
string(100) |
The code of the group to which the article belongs |
ProductCode |
string(200) |
Product code |
BarCode |
string(100) |
The barcode/EAN of the article |
ArticleUnitCode |
string(50) |
The unit code of the article (e.g. "pcs") |
Description |
string(3000) |
The article description |
ArticleReturnHandlingComment |
string(500) |
The article return handling comment |
LinkToPicture |
string(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 |
ArticleClasses |
ArticleClassInfoAutomation[] |
Alternative classes for this article. Contains ArticleClassInfoAutomation objects |
IsSerialNumberArticle |
boolean |
True if the article is a serial number article, false otherwise |
IsExpiryDateArticle |
boolean |
True if the article is an expiry date article, false otherwise |
OrderArticleItemInfoOrderInfo |
OrderId |
int |
Ongoing WMS' internal id for the order |
OrderNumber |
string(50) |
The goods owner order number |
Consignee |
OrderArticleItemInfoConsignee |
An OrderArticleItemInfoConsignee object, containing information about the order's consignee (customer) |
TransporterOrderNumber |
string(150) |
Transporter order number |
OrderLineId |
int |
Ongoing WMS internal ID for the order line |
IsPacked |
boolean |
Whether or not the article item has been packed |
IsPicked |
boolean |
Whether or not the article item has been picked |
IsReturned |
boolean |
Whether or not the article item has been returned |
ArticleInfoAlternativeBarcode |
Barcode |
string(100) |
The alternative barcode. |
QuantityPerBarcode |
decimal |
The package size if this is used to define a package. |
Type |
ArticleInfoAlternativeBarcodeType |
An ArticleInfoAlternativeBarcodeType object. |
ArticleClassInfoAutomation |
Name |
string(50) |
The name of the article class. |
Code |
string(50) |
The the code of the article class. |
Id |
int |
The Ongoing system ID of the article class. |
OrderArticleItemInfoConsignee |
Name |
string(200) |
The name of the consignee |
CustomerGroupCode |
string(50) |
The code of the group which the customer belongs to |
CustomerGroupName |
string(100) |
The name for the group which the customer belongs to |
ArticleInfoAlternativeBarcodeType |
Name |
string(300) |
The name of the type. |
Code |
string(300) |
The code of the type. |