Ongoing Warehouse logo

Ongoing Warehouse Developer

GetInventoryItems

This function returns detailed stock information for each article which matches the specified filter. It does not summarize the values.

Please see this article for more information about what can be accomplished with this function.

Tags: GetInventoryItems, InventoryItemsQuery, GetInventoryResult, InventoryItems, InventoryItem, InventoryItemLockCauses

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

<?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>
    <GetInventoryItems xmlns="http://ongoingsystems.se/WSI">
      <GoodsOwnerId>int</GoodsOwnerId>
      <UserName>string</UserName>
      <Password>string</Password>
      <InventoryItemsQuery>
          <GetZeroStockArticles>boolean</GetZeroStockArticles>
          <FilterBySerial>
              <string>string</string>
              <string>string</string>
          </FilterBySerial>
          <FilterByArticleNumber>
              <string>string</string>
              <string>string</string>
          </FilterByArticleNumber>
          <ArticleItemStatusChangedFrom>dateTime</ArticleItemStatusChangedFrom>
          <LastInventoryTimeFrom>dateTime</LastInventoryTimeFrom>
          <PreviousArticleItemStatus>
            <PreviousArticleItemStatusCode>string</PreviousArticleItemStatusCode>
            <PreviousArticleItemStatusTime>dateTime</PreviousArticleItemStatusTime>
          </PreviousArticleItemStatus>
          <MaxArticlesToGet>int</MaxArticlesToGet>
          <ArticleSystemIdFrom>int</ArticleSystemIdFrom>
      </InventoryItemsQuery>
    </GetInventoryItems>
  </soap:Body>
</soap:Envelope>
+

Request specification

GetInventoryItems
GoodsOwnerId int Req. The id of the client
UserName str(50) Req. Your username
Password str(50) Req. Your password
GetInventoryItems object Req. Defines the query, what to filter for
InventoryItemsQuery
GetZeroStockArticles boolean Obsolete. Do not use.
FilterBySerial object A list of strings. Each string represents a serial number.
string str(128)[] Which serial number to filter for.
FilterByArticleNumber object A list of strings. Each string represents an article number.
string str(128)[] Which article number to filter for.
ArticleItemStatusChangedFrom dateTime Only show article items whose article item status has changed since this date.
LastInventoryTimeFrom dateTime Only show article items who have been inventoried since this date.
PreviousArticleItemStatus object Only show items whose article item status status was changed to PreviousArticleItemStatusCode before PreviousArticleItemStatusTime
> PreviousArticleItemStatusCode str(50)
> PreviousArticleItemStatusTime datetime
MaxArticlesToGet int Max number of articles to return
ArticleSystemIdFrom int If specified, the API will only return those articles who article system id is greater than ArticleSystemIdFrom. In combination with MaxArticlesToGet, this allows to request inventory items in batches of e.g 100 articles, rather than having to request everything at once.

Response XML

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-16" ?>
<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>
    <GetInventoryItemsResponse xmlns="http://ongoingsystems.se/WSI">
      <GetInventoryItemsResult>
        <GoodsOwnerId>int</GoodsOwnerId>
        <InventoryItemLines>
          <InventoryItemLine>
            <Article xsi:nil="true" />
            <InventoryItems>
              <InventoryItem>
                <Batch>string</Batch>
                <ExpiryDate>dateTime</ExpiryDate>
                <NumberOfItems>decimal</NumberOfItems>
                <ArticleItemStatusCode>string</ArticleItemStatusCode>
                <ArticleItemStatusName>string</ArticleItemStatusName>
                <Serial>string</Serial>
                <ArticleItemComment>string</ArticleItemComment>
                <Location>string</Location>
                <InDate>dateTime</InDate>
                <IsLocked>boolean</IsLocked>
                <Length>decimal</Length>
                <Width>decimal</Width>
                <Height>decimal</Height>
                <Weight>decimal</Weight>
                <Volume>decimal</Volume>
                <InOrderNumber>string</InOrderNumber>
                <LastInventoryTime>dateTime</LastInventoryTime>
                <WarehouseCode>string</WarehouseCode>
                <IsLockedForSale>boolean</IsLockedForSale>
                <Container>string</Container>
                <LockCauses>
                  <ByAllocation>boolean</ByAllocation>
                  <ByInventory>boolean</ByInventory>
                  <ByItemLock>boolean</ByItemLock>
                  <ByLocation>boolean</ByLocation>
                  <ByStatus>boolean</ByStatus>
                  <ByWarehouseTransferOrder>boolean</ByWarehouseTransferOrder>
                </LockCauses>
              </InventoryItem>
              <InventoryItem>
                <Batch>string</Batch>
                <ExpiryDate>dateTime</ExpiryDate>
                <NumberOfItems>decimal</NumberOfItems>
                <ArticleItemStatusCode>string</ArticleItemStatusCode>
                <ArticleItemStatusName>string</ArticleItemStatusName>
                <Serial>string</Serial>
                <ArticleItemComment>string</ArticleItemComment>
                <Location>string</Location>
                <InDate>dateTime</InDate>
                <IsLocked>boolean</IsLocked>
                <Length>decimal</Length>
                <Width>decimal</Width>
                <Height>decimal</Height>
                <Weight>decimal</Weight>
                <Volume>decimal</Volume>
                <InOrderNumber>string</InOrderNumber>
                <LastInventoryTime>dateTime</LastInventoryTime>
                <WarehouseCode>string</WarehouseCode>
                <IsLockedForSale>boolean</IsLockedForSale>
                <Container>string</Container>
                <LockCauses>
                  <ByAllocation>boolean</ByAllocation>
                  <ByInventory>boolean</ByInventory>
                  <ByItemLock>boolean</ByItemLock>
                  <ByLocation>boolean</ByLocation>
                  <ByStatus>boolean</ByStatus>
                  <ByWarehouseTransferOrder>boolean</ByWarehouseTransferOrder>
                </LockCauses>
              </InventoryItem>
            </InventoryItems>
          </InventoryItemLine>
          <InventoryItemLine>
            <Article xsi:nil="true" />
            <InventoryItems>
              <InventoryItem>
                <Batch>string</Batch>
                <ExpiryDate>dateTime</ExpiryDate>
                <NumberOfItems>decimal</NumberOfItems>
                <ArticleItemStatusCode>string</ArticleItemStatusCode>
                <ArticleItemStatusName>string</ArticleItemStatusName>
                <Serial>string</Serial>
                <ArticleItemComment>string</ArticleItemComment>
                <Location>string</Location>
                <InDate>dateTime</InDate>
                <IsLocked>boolean</IsLocked>
                <Length>decimal</Length>
                <Width>decimal</Width>
                <Height>decimal</Height>
                <Weight>decimal</Weight>
                <Volume>decimal</Volume>
                <InOrderNumber>string</InOrderNumber>
                <LastInventoryTime>dateTime</LastInventoryTime>
                <WarehouseCode>string</WarehouseCode>
                <IsLockedForSale>boolean</IsLockedForSale>
                <Container>string</Container>
                <LockCauses>
                  <ByAllocation>boolean</ByAllocation>
                  <ByInventory>boolean</ByInventory>
                  <ByItemLock>boolean</ByItemLock>
                  <ByLocation>boolean</ByLocation>
                  <ByStatus>boolean</ByStatus>
                  <ByWarehouseTransferOrder>boolean</ByWarehouseTransferOrder>
                </LockCauses>
              </InventoryItem>
              <InventoryItem>
                <Batch>string</Batch>
                <ExpiryDate>dateTime</ExpiryDate>
                <NumberOfItems>decimal</NumberOfItems>
                <ArticleItemStatusCode>string</ArticleItemStatusCode>
                <ArticleItemStatusName>string</ArticleItemStatusName>
                <Serial>string</Serial>
                <ArticleItemComment>string</ArticleItemComment>
                <Location>string</Location>
                <InDate>dateTime</InDate>
                <IsLocked>boolean</IsLocked>
                <Length>decimal</Length>
                <Width>decimal</Width>
                <Height>decimal</Height>
                <Weight>decimal</Weight>
                <Volume>decimal</Volume>
                <InOrderNumber>string</InOrderNumber>
                <LastInventoryTime>dateTime</LastInventoryTime>
                <WarehouseCode>string</WarehouseCode>
                <IsLockedForSale>boolean</IsLockedForSale>
                <Container>string</Container>
                <LockCauses>
                  <ByAllocation>boolean</ByAllocation>
                  <ByInventory>boolean</ByInventory>
                  <ByItemLock>boolean</ByItemLock>
                  <ByLocation>boolean</ByLocation>
                  <ByStatus>boolean</ByStatus>
                  <ByWarehouseTransferOrder>boolean</ByWarehouseTransferOrder>
                </LockCauses>
              </InventoryItem>
            </InventoryItems>
          </InventoryItemLine>
        </InventoryItemLines>
      </GetInventoryItemsResult>
    </GetInventoryItemsResponse>
  </soap:Body>
</soap:Envelope>
+

Response specification

GetInventoryResult
GoodsOwnerId int System id of the goods owner
InventoryItemLines object Containing elements of InventoryItems
InventoryItems
InventoryItem object Containing elements of InventoryItem
Article object Basic article data. See here for a specification.
InventoryItem
Batch str(50) The batch number of the item.
ExpiryDate datetime The expiry date of the item.
NumberOfItems dec The quantity contained in this item.
ArticleItemStatusCode str(50) The status code for the item.
ArticleItemStatusName str(100) The status name for the item.
Serial str(128) The serial number of the item.
ArticleItemComment str(400) The comment for the item.
Location str(50) The name of the location where the item has been placed.
InDate datetime The time when the item was received.
IsLocked bool Whether or note the item is locked.
Length dec Length of the item, in meters.
Width dec Width of the item, in meters.
Height dec Height of the item, in meters.
Weight dec Weight of the item, in kilograms.
Volume dec Volume of the item, in cubic meters.
InOrderNumber str(50) The InOrderNumber on which this item was inbounded.
LastInventoryTime datetime The time the item was last inventoried.
WarehouseCode str(50) Code of the warehouse where this item is located.
IsLockedForSale bool Whether or not this item is locked for sale.
Container str(50) Container
LockCauses object Object of type InventoryItemLockCauses which shows the reasons which the item is locked (there may be multiple reasons). If the item is not locked, then this value will be null.
InventoryItemLockCauses
ByAllocation bool True if the item is locked because it is allocated on an outbound order, false otherwise.
ByInventory bool True if the item is locked because the warehouse is currently inventorying it, false otherwise.
ByItemLock bool True if the warehouse has specifically locked this particular item, false otherwise.
ByLocation bool True if the item is locked because it has been placed in a locked location, false otherwise.
ByStatus bool True if the item is locked because its article item status is locked, false otherwise.
ByWarehouseTransferOrder bool True if the item is locked because it has been placed on a warehouse transfer order, false otherwise.