GetInOrdersByQuery (automation API)
This function allows you to query for information about specific inorders.
Note that the goods owner SOAP API contains a function with the exact same name. So we have:
- GetInOrdersByQuery in the goods owner SOAP API.
- GetInOrdersByQuery in the automation API (the function described on this page).
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/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/Automation"> <UserName>string</UserName> <Password>string</Password> <Query> <InOrderIds> <int>int</int> <int>int</int> </InOrderIds> <LastReceiveTimeFrom>dateTime</LastReceiveTimeFrom> <LastReceiveTimeTo>dateTime</LastReceiveTimeTo> <MaxInOrdersToGet>int</MaxInOrdersToGet> <InOrderIdFrom>int</InOrderIdFrom> <InOrderStatusChangedTimeFrom>dateTime</InOrderStatusChangedTimeFrom> <CreatedTimeFrom>dateTime</CreatedTimeFrom> <WarehouseIds> <int>int</int> <int>int</int> </WarehouseIds> <GoodsOwnerId>int</GoodsOwnerId> <InOrderStatusFrom>int</InOrderStatusFrom> <InOrderStatusTo>int</InOrderStatusTo> <InOrderSpecialFilters> <OnlyWithInOrderLinesWithDiffingReceivedToReported>boolean</OnlyWithInOrderLinesWithDiffingReceivedToReported> <OnlyWithInOrderLinesWithDiffingReceivedToAcknowledged>boolean</OnlyWithInOrderLinesWithDiffingReceivedToAcknowledged> </InOrderSpecialFilters> </Query> </GetInOrdersByQuery> </soap:Body> </soap:Envelope>
|InOrderIds||int||A list of inorder ids|
|LastReceiveTimeFrom||datetime||Only return inorders where goods have been received after this time|
|LastReceiveTimeTo||datetime||Only return inorders where goods have been received before this time|
|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.|
|InOrderStatusChangedTimeFrom||datetime||Filter for inorders where the inorder status has been changed after this time.|
|CreatedTimeFrom||datetime||Filter for inorders where the inorder was created after this time.|
|WarehouseIds||int||Only get purchase orders which are supposed to be received by the specified warehouses.|
|GoodsOwnerId||int||Filter for orders which belong to a specific goods owner|
|InOrderStatusFrom||int||InOrder status from|
|InOrderStatusTo||int||InOrder status to|
|InOrderSpecialFilters||object||Contains special filters|
|> OnlyWithInOrderLines... ...WithDiffingReceivedToReported||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|
For the response specification, please see the documentation for the regular GetInOrderByOrderNumber function. The response will contain a list of objects which each have the same type as the the objects from GetInOrderByOrderNumber.