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:

1. GetInOrdersByQuery in the goods owner SOAP API.
2. GetInOrdersByQuery in the automation API (the function described on this page).

These two functions are very similar, indeed they return the same type of object. The difference lies in the fact that the GetInOrdersByQuery function in the automation API does not have as many ways to query for orders, and it also gives you access to orders from all goods owners in the system.

Tags: GetInOrdersByQuery

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/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>
      </Query>
    </GetInOrdersByQuery>
  </soap:Body>
</soap:Envelope>

Request specification

GetInOrdersByQuery
UserName	str(50)	Req.	Your username.
Password	str(50)	Req.	Your password.
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.

Response XML

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.