GetInboundTransactionsByQuery

This function retrieves inbound transactions.

Tags: GetInboundTransactions, GetInboundTransactionsResult, InboundTransaction, GoodsOwner, Article, ByUser, Location, InOrder, ArticleItemStatus, Error

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

Request specification

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

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>
    <GetInboundTransactionsByQueryResponse xmlns="http://ongoingsystems.se/Automation">
      <GetInboundTransactionsResult>
        <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>
      </GetInboundTransactionsResult>
    </GetInboundTransactionsByQueryResponse>
  </soap:Body>
</soap:Envelope>

Response specification

GetInboundTransactionsResult
Success boolean If the operation was successful. If not, check Error for more details on what went wrong.
InboundTransactions object List of inbound transactions, see InboundTransaction.
Error object Error details, see Error.
InboundTransaction
GoodsOwner object See GoodsOwner.
Article object See Article.
ByUser object See ByUser.
Batch str(50) Which batch the inbound transaction belongs to.
Serial str(128) Which serial number the inbound transaction has.
Container str(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 str(400) A comment belonging to the inbound transaction.
OriginalArticleItemId int The original article item id of the inbound item.
Location object See Location.
InOrder object See InOrder.
ArticleItemStatus object See ArticleItemStatus.
GoodsOwner
GoodsOwnerId int The id of the goods owner.
GoodsOwnerName str(400) The name of the goods owner.
Article
ArticleDefId int The id of the article.
ArticleNumber str(100) The article number.
ByUser
UserId int The id of the user.
UserName str(50) The name of the user.
Location
LocationId int The id of the location.
Location str(50) The name of the location.
InOrder
InOrderId int The incoming order id.
InOrderNumber str(50) The name of the incoming order.
ArticleItemStatus
Code str(50) The item status code.
Name str(100) The item status name.
Error
ErrorType enum LogonError: Failed to log in.
Unknown: Something else went wrong, see message.
Message str(400) A message describing the error.