GetInboundTransactionsByQuery (automation API)

This function retrieves inbound transactions.

Tags: GetInboundTransactionsByQuery, GetInboundTransactionsQuery, GetInboundTransactionsByQueryResponse, GetInboundTransactionsResult, InboundTransaction, GetInboundTransactionsErrorResult, GoodsOwner_GetInboundTransactions, ArticleInfo_GetInboundTransactions, ByUser_GetInboundTransactions, Location_GetInboundTransactions, InOrder_GetInboundTransactions, ArticleItemStatus_GetInboundTransactions

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/GetInboundTransactionsByQuery"

<?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>
    <GetInboundTransactionsByQuery xmlns="http://ongoingsystems.se/Automation">
      <UserName>string</UserName>
      <Password>string</Password>
      <Query>
        <InDateFrom>dateTime</InDateFrom>
        <InDateTo>dateTime</InDateTo>
        <WarehouseId>int</WarehouseId>
        <OnlyLiveGoodsOwners>boolean</OnlyLiveGoodsOwners>
        <GoodsOwnerId>int</GoodsOwnerId>
        <MaxOriginalArticleItemIdsToGet>int</MaxOriginalArticleItemIdsToGet>
        <OriginalArticleItemIdFrom>int</OriginalArticleItemIdFrom>
      </Query>
    </GetInboundTransactionsByQuery>
  </soap:Body>
</soap:Envelope>

Request specification

GetInboundTransactionsByQuery
UserName string(50) Req. Your username
Password string(50) Req. Your password
Query GetInboundTransactionsQuery Req. The query object
GetInboundTransactionsQuery
InDateFrom dateTime Filter inbound transactions to transactions after this time.
InDateTo dateTime Filter inbound transactions to transactions before this time.
WarehouseId int The id of the warehouse to get inbound transactions from.
OnlyLiveGoodsOwners boolean If only inbound transactions from live goods owners should be retrieved.
GoodsOwnerId int The id of the goods owner for which inbound transactions are being retrieved.
MaxOriginalArticleItemIdsToGet int Max number of articles inbound transactions should be retrieved.
OriginalArticleItemIdFrom int Filter transactions to OriginalArticleItemId from this.

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>
    <GetInboundTransactionsByQueryResponse xmlns="http://ongoingsystems.se/Automation">
      <GetInboundTransactionsByQueryResult>
        <Success>boolean</Success>
        <InboundTransactions>
          <InboundTransaction>
            <GoodsOwner>
              <GoodsOwnerId>int</GoodsOwnerId>
              <GoodsOwnerName>string</GoodsOwnerName>
            </GoodsOwner>
            <Article>
              <ArticleDefId>int</ArticleDefId>
              <ArticleNumber>string</ArticleNumber>
            </Article>
            <ByUser>
              <UserId>int</UserId>
              <UserName>string</UserName>
            </ByUser>
            <Batch>string</Batch>
            <Serial>string</Serial>
            <Container>string</Container>
            <InDate>dateTime</InDate>
            <ExpiryDate>dateTime</ExpiryDate>
            <NumberOfItems>decimal</NumberOfItems>
            <Comment>string</Comment>
            <OriginalArticleItemId>int</OriginalArticleItemId>
            <Location>
              <LocationId>int</LocationId>
              <Location>string</Location>
            </Location>
            <InOrder>
              <InOrderId>int</InOrderId>
              <InOrderNumber>string</InOrderNumber>
            </InOrder>
            <ArticleItemStatus>
              <Code>string</Code>
              <Name>string</Name>
            </ArticleItemStatus>
          </InboundTransaction>
          <InboundTransaction>
            <GoodsOwner>
              <GoodsOwnerId>int</GoodsOwnerId>
              <GoodsOwnerName>string</GoodsOwnerName>
            </GoodsOwner>
            <Article>
              <ArticleDefId>int</ArticleDefId>
              <ArticleNumber>string</ArticleNumber>
            </Article>
            <ByUser>
              <UserId>int</UserId>
              <UserName>string</UserName>
            </ByUser>
            <Batch>string</Batch>
            <Serial>string</Serial>
            <Container>string</Container>
            <InDate>dateTime</InDate>
            <ExpiryDate>dateTime</ExpiryDate>
            <NumberOfItems>decimal</NumberOfItems>
            <Comment>string</Comment>
            <OriginalArticleItemId>int</OriginalArticleItemId>
            <Location>
              <LocationId>int</LocationId>
              <Location>string</Location>
            </Location>
            <InOrder>
              <InOrderId>int</InOrderId>
              <InOrderNumber>string</InOrderNumber>
            </InOrder>
            <ArticleItemStatus>
              <Code>string</Code>
              <Name>string</Name>
            </ArticleItemStatus>
          </InboundTransaction>
        </InboundTransactions>
        <Error>
          <ErrorType>Unknown or LogonError</ErrorType>
          <Message>string</Message>
        </Error>
      </GetInboundTransactionsByQueryResult>
    </GetInboundTransactionsByQueryResponse>
  </soap:Body>
</soap:Envelope>

Response specification

GetInboundTransactionsByQueryResponse
GetInboundTransactionsByQueryResult GetInboundTransactionsResult
GetInboundTransactionsResult
Success boolean If the operation was successful. If not, check GetInboundTransactionsErrorResult for more details on what went wrong.
InboundTransactions InboundTransaction[] List of inbound transactions, see InboundTransaction.
Error GetInboundTransactionsErrorResult Error details, see GetInboundTransactionsErrorResult.
InboundTransaction
GoodsOwner GoodsOwner_GetInboundTransactions See GoodsOwner_GetInboundTransactions.
Article ArticleInfo_GetInboundTransactions See ArticleInfo_GetInboundTransactions.
ByUser ByUser_GetInboundTransactions See ByUser_GetInboundTransactions.
Batch string(50) Which batch the inbound transaction belongs to.
Serial string(128) Which serial number the inbound transaction has.
Container string(50) Which container the inbound transaction is targeting.
InDate dateTime The date and time of when the transaction arrives.
ExpiryDate dateTime The date of when the transaction items expire. OBS! Can be null.
NumberOfItems decimal The number of items in the transaction.
Comment string(400) A comment belonging to the inbound transaction.
OriginalArticleItemId int The original article item id of the inbound item.
Location Location_GetInboundTransactions See Location_GetInboundTransactions.
InOrder InOrder_GetInboundTransactions See InOrder_GetInboundTransactions.
ArticleItemStatus ArticleItemStatus_GetInboundTransactions See ArticleItemStatus_GetInboundTransactions.
GetInboundTransactionsErrorResult
ErrorType enum An element of type GetInboundTransactionsErrorType.
Message string
GoodsOwner_GetInboundTransactions
GoodsOwnerId int The id of the goods owner.
GoodsOwnerName string(400) The name of the goods owner.
ArticleInfo_GetInboundTransactions
ArticleDefId int The id of the article.
ArticleNumber string(100) The article number.
ByUser_GetInboundTransactions
UserId int The id of the user.
UserName string(50) The name of the user.
Location_GetInboundTransactions
LocationId int The id of the location.
Location string(50) The name of the location.
InOrder_GetInboundTransactions
InOrderId int The incoming order id.
InOrderNumber string(50) The name of the incoming order.
ArticleItemStatus_GetInboundTransactions
Code string(50) The item status code.
Name string(100) The item status name.