GetInOrdersByQuery
This function allows getting multiple inorders within a certain search critera. A common way to use this function is to filter for a certain status and use last updated in order to just get the latest inorders.
Tags: GetInOrdersByQuery, query, Advanced, GetOrdersByQueryResult
Request XML
POST /xxx/service.asmx HTTP/1.1
Host: api.ongoingsystems.se
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ongoingsystems.se/WSI/GetInOrdersByQuery"
<?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>
<GetInOrdersByQuery xmlns="http://ongoingsystems.se/WSI">
<GoodsOwnerCode>string</GoodsOwnerCode>
<UserName>string</UserName>
<Password>string</Password>
<query>
<InDateFrom>dateTime</InDateFrom>
<InDateTo>dateTime</InDateTo>
<LastReceiveTimeFrom>dateTime</LastReceiveTimeFrom>
<LastReceiveTimeTo>dateTime</LastReceiveTimeTo>
<InOrderStatusFrom>int</InOrderStatusFrom>
<InOrderStatusTo>int</InOrderStatusTo>
<IsReturnType>boolean</IsReturnType>
<InOrderIdsToGet>
<int>int</int>
<int>int</int>
</InOrderIdsToGet>
<InOrderNumbersToGet>
<string>string</string>
<string>string</string>
</InOrderNumbersToGet>
<InOrderSpecialFilters>
<OnlyGetUnDeclaredInOrders>boolean</OnlyGetUnDeclaredInOrders>
<OnlyWithInOrderLinesWithDiffingReceviedToReported>boolean</OnlyWithInOrderLinesWithDiffingReceviedToReported>
<OnlyWithInOrderLinesWithDiffingReceivedToAcknowledged>boolean</OnlyWithInOrderLinesWithDiffingReceivedToAcknowledged>
</InOrderSpecialFilters>
<LastUpdatedFrom>dateTime</LastUpdatedFrom>
<LastUpdatedTo>dateTime</LastUpdatedTo>
<MaxInOrdersToGet>int</MaxInOrdersToGet>
<InOrderIdFrom>int</InOrderIdFrom>
<LastReceiveTimeOrLastUpdatedFrom>dateTime</LastReceiveTimeOrLastUpdatedFrom>
<Advanced>
<IncludeAdvisedArticleItemsInReceivedArticleItems>boolean</IncludeAdvisedArticleItemsInReceivedArticleItems>
</Advanced>
</query>
</GetInOrdersByQuery>
</soap:Body>
</soap:Envelope>
Request specification
GetInOrdersByQuery |
GoodsOwnerCode |
str(400) |
Req. |
The name/code of your client |
UserName |
str(50) |
Req. |
Your username |
Password |
str(50) |
Req. |
Your password |
query |
object |
Req. |
Specifies the query/search criteria |
query |
InDateFrom |
datetime |
|
Indate from |
InDateTo |
datetime |
|
Indate to |
LastReceiveTimeFrom |
datetime |
|
Most recent datetime of receiving an item, from |
LastReceiveTimeTo |
datetime |
|
Most recent datetime of receiving an item, to |
InOrderStatusFrom |
int |
|
InOrder status from |
InOrderStatusTo |
int |
|
InOrder status to |
IsReturnType |
bool |
|
Specifies filter for inorders representing a return |
InOrderNumbersToGet |
object |
|
Containing elements of string, defining inorder numbers to get |
string |
str(50)[] |
|
InOrder number to get |
InOrderIdsToGet |
object |
|
Containing elements of int, defining inorder ids to get |
int |
int[] |
|
InOrder ids to get |
InOrderSpecialFilters |
object |
|
Contains special filters |
> OnlyGetUnDeclaredInOrders |
bool |
|
Filters whether the inorders should be marked as declared |
> OnlyWithInOrderLines... ...WithDiffingReceviedToReported |
bool |
|
Filters whether the inorders should have a diff between reported and received amount |
> OnlyWithInOrderLines... ...WithDiffingReceivedToAcknowledged |
bool |
|
Filters whether the inorders should have a diff between acknowledged and received amount |
LastUpdatedFrom |
datetime |
|
Last datetime an inorder was updated, from |
LastUpdatedTo |
datetime |
|
Last datetime an inorder was updated, to |
MaxInOrdersToGet |
int |
|
Max number of inorders to return in response |
InOrderIdFrom |
int |
|
If specified, the API will only respond with inorders whose system Ids are greater than or equal to (>=) the specified id. In conjunction with MaxInOrdersToGet this allows you to request inorders in batches of e.g. 100, rather than having to request all inorders at once. |
LastReceivedTimeOrUpdatedFrom |
datetime |
|
Most recent datetime of receiving an item or last datetime an inorder was updated, from |
Advanced |
object |
|
Contains advanced query parameters that most integrations will never use. |
Advanced |
IncludeAdvisedArticleItemsInReceivedArticleItems |
bool |
|
Specifies whether or not to include article items that have been advised but not yet received in the ReceivedArticleItems part of the response. A ReceivedArticlItem representing an article item that has not yet been received will have an empty Location field. |
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>
<GetInOrdersByQueryResponse xmlns="http://ongoingsystems.se/WSI">
<GetInOrdersByQueryResult>
<InOrders>
<ReceivedInOrder>
<InOrderInfo xsi:nil="true" />
<InOrderSupplier xsi:nil="true" />
<GoodsOwner xsi:nil="true" />
<WsiSystem xsi:nil="true" />
<ReceivedInOrderLines xsi:nil="true" />
<ReceivedArticleItems xsi:nil="true" />
<InOrderCustomer xsi:nil="true" />
</ReceivedInOrder>
<ReceivedInOrder>
<InOrderInfo xsi:nil="true" />
<InOrderSupplier xsi:nil="true" />
<GoodsOwner xsi:nil="true" />
<WsiSystem xsi:nil="true" />
<ReceivedInOrderLines xsi:nil="true" />
<ReceivedArticleItems xsi:nil="true" />
<InOrderCustomer xsi:nil="true" />
</ReceivedInOrder>
</InOrders>
</GetInOrdersByQueryResult>
</GetInOrdersByQueryResponse>
</soap:Body>
</soap:Envelope>
Response specification
GetInOrdersByQueryResult |
InOrders |
object |
Containing elements of ReceivedInOrder |
ReceivedInOrder |
object[] |
Inorders that fit the search critera. ReceivedInOrder is the same object as GetInOrderByOrderNumberResult in GetInOrderByOrderNumber. |