Ongoing WMS logo

Ongoing WMS Developer

GetArticlesByQuery

This function lets you retrieve information about articles (SKUs).

Tags: GetArticlesByQuery, Query, GetArticlesBarcodeFilters, GetArticlesArticleInfo

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

<?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>
    <GetArticlesByQuery xmlns="http://ongoingsystems.se/Automation">
      <UserName>string</UserName>
      <Password>string</Password>
      <Query>
        <ArticleDefIds>
          <int>int</int>
          <int>int</int>
        </ArticleDefIds>
        <GoodsOwnerId>int</GoodsOwnerId>
        <DefaultPickingLocation>string</DefaultPickingLocation>
        <MaxArticlesToGet>int</MaxArticlesToGet>
        <ArticleDefIdFrom>int</ArticleDefIdFrom>
        <OnlyLiveGoodsOwners>boolean</OnlyLiveGoodsOwners>
        <ArticleNumber>string</ArticleNumber>
        <Barcodes>
          <Barcode>string</Barcode>
          <AlternativeBarcode>string</AlternativeBarcode>
          <BarcodePallet>string</BarcodePallet>
          <BarcodePackage>string</BarcodePackage>
        </Barcodes>
      </Query>
    </GetArticlesByQuery>
  </soap:Body>
</soap:Envelope>
+

Request specification

GetArticlesPackageTypes
UserName str(50) Req. Your username.
Password str(50) Req. Your password.
Query object Req. Specifies the query/search criteria
Query
ArticleDefIds object The article def ids which you want to get
> int int[] Req. Article def ids to get
GoodsOwnerId int Only get articles for this goods owner
DefaultPickingLocation str Only get articles whose default picking location is this
MaxArticlesToGet int Max number of articles to return in response
ArticleDefIdFrom int If specified, the API will only respond with articles whose system Ids are greater than or equal to (>=) the specified id. In conjunction with MaxArticlesToGet this allows you to request articles in batches of e.g. 100, rather than having to request all articles at once.
OnlyLiveGoodsOwners bool If true, then the API will only return articles which belong to goods owners which have been marked as "live".
ArticleNumber str(100) Filter using article number.
Barcodes obj Object of type GetArticlesBarcodeFilters. Used to filter for articles using barcodes. Each article in Ongoing WMS has several different barcode fields.
GetArticlesBarcodeFilters
Barcode str(100) Filter using the article's barcode.
AlternativeBarcode str(100) Filter using the article's alternative barcodes.
BarcodePallet str(100) Filter using the article's pallet barcode.
BarcodePackage str(100) Filter using the article's package barcode.

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>
    <GetArticlesByQueryResponse xmlns="http://ongoingsystems.se/Automation">
      <GetArticlesByQueryResult>
        <Message>string</Message>
        <Success>boolean</Success>
        <Articles>
          <Article>
            <ArticleDefId>int</ArticleDefId>
            <ArticleNumber>string</ArticleNumber>
            <ArticleName>string</ArticleName>
            <ProductCode>string</ProductCode>
            <BarCode>string</BarCode>
            <BarCodePackage>string</BarCodePackage>
            <BarCodePallet>string</BarCodePallet>
            <QuantityPerPallet>decimal</QuantityPerPallet>
            <QuantityPerPackage>decimal</QuantityPerPackage>
            <QuantityPerLayer>decimal</QuantityPerLayer>
            <Description>string</Description>
            <SupplierArticleNumber>string</SupplierArticleNumber>
            <StatisticsNumber>string</StatisticsNumber>
            <ArticleGroup>
              <Name>string</Name>
              <Code>string</Code>
            </ArticleGroup>
            <MainSupplier>
              <SupplierName>string</SupplierName>
              <SupplierNumber>string</SupplierNumber>
              <SupplierId>int</SupplierId>
            </MainSupplier>
            <ArticleCategory>
              <Name>string</Name>
              <Code>string</Code>
            </ArticleCategory>
            <ArticleSize>
              <Name>string</Name>
              <Code>string</Code>
            </ArticleSize>
            <ArticleColor>
              <Name>string</Name>
              <Code>string</Code>
            </ArticleColor>
            <ArticleUnit>
              <UnitCode>string</UnitCode>
            </ArticleUnit>
            <GoodsOwner>
              <Name>string</Name>
              <GoodsOwnerId>int</GoodsOwnerId>
              <IsTrainingGoodsOwner>boolean</IsTrainingGoodsOwner>
            </GoodsOwner>
            <Length>decimal</Length>
            <Width>decimal</Width>
            <Height>decimal</Height>
            <Price>decimal</Price>
            <Weight>decimal</Weight>
            <NetWeight>decimal</NetWeight>
            <Volume>decimal</Volume>
            <PurchaseCurrency>
              <code>string</code>
            </PurchaseCurrency>
            <CountryOfOrigin>
              <Code>string</Code>
            </CountryOfOrigin>
            <PurchasePrice>decimal</PurchasePrice>
            <StockLimit>int</StockLimit>
            <FreeDecimal1>decimal</FreeDecimal1>
            <FreeDecimal2>decimal</FreeDecimal2>
            <DefaultPickingLocation>
              <Location>string</Location>
              <LocationId>int</LocationId>
            </DefaultPickingLocation>
            <DefaultPickingLocationMaxNumberOfItems>decimal</DefaultPickingLocationMaxNumberOfItems>
            <DefaultPickingLocationStockLimit>decimal</DefaultPickingLocationStockLimit>
            <ArticleKind>Stock or Production or Structure or NonStock</ArticleKind>
            <MaxStackNumberOfLevels>decimal</MaxStackNumberOfLevels>
            <GoodsCategory>
              <Name>string</Name>
              <Code>string</Code>
            </GoodsCategory>
            <StorageClass>
              <Name>string</Name>
            </StorageClass>
          </Article>
          <Article>
            <ArticleDefId>int</ArticleDefId>
            <ArticleNumber>string</ArticleNumber>
            <ArticleName>string</ArticleName>
            <ProductCode>string</ProductCode>
            <BarCode>string</BarCode>
            <BarCodePackage>string</BarCodePackage>
            <BarCodePallet>string</BarCodePallet>
            <QuantityPerPallet>decimal</QuantityPerPallet>
            <QuantityPerPackage>decimal</QuantityPerPackage>
            <QuantityPerLayer>decimal</QuantityPerLayer>
            <Description>string</Description>
            <SupplierArticleNumber>string</SupplierArticleNumber>
            <StatisticsNumber>string</StatisticsNumber>
            <ArticleGroup>
              <Name>string</Name>
              <Code>string</Code>
            </ArticleGroup>
            <MainSupplier>
              <SupplierName>string</SupplierName>
              <SupplierNumber>string</SupplierNumber>
              <SupplierId>int</SupplierId>
            </MainSupplier>
            <ArticleCategory>
              <Name>string</Name>
              <Code>string</Code>
            </ArticleCategory>
            <ArticleSize>
              <Name>string</Name>
              <Code>string</Code>
            </ArticleSize>
            <ArticleColor>
              <Name>string</Name>
              <Code>string</Code>
            </ArticleColor>
            <ArticleUnit>
              <UnitCode>string</UnitCode>
            </ArticleUnit>
            <GoodsOwner>
              <Name>string</Name>
              <GoodsOwnerId>int</GoodsOwnerId>
              <IsTrainingGoodsOwner>boolean</IsTrainingGoodsOwner>
            </GoodsOwner>
            <Length>decimal</Length>
            <Width>decimal</Width>
            <Height>decimal</Height>
            <Price>decimal</Price>
            <Weight>decimal</Weight>
            <NetWeight>decimal</NetWeight>
            <Volume>decimal</Volume>
            <PurchaseCurrency>
              <code>string</code>
            </PurchaseCurrency>
            <CountryOfOrigin>
              <Code>string</Code>
            </CountryOfOrigin>
            <PurchasePrice>decimal</PurchasePrice>
            <StockLimit>int</StockLimit>
            <FreeDecimal1>decimal</FreeDecimal1>
            <FreeDecimal2>decimal</FreeDecimal2>
            <DefaultPickingLocation>
              <Location>string</Location>
              <LocationId>int</LocationId>
            </DefaultPickingLocation>
            <DefaultPickingLocationMaxNumberOfItems>decimal</DefaultPickingLocationMaxNumberOfItems>
            <DefaultPickingLocationStockLimit>decimal</DefaultPickingLocationStockLimit>
            <ArticleKind>Stock or Production or Structure or NonStock</ArticleKind>
            <MaxStackNumberOfLevels>decimal</MaxStackNumberOfLevels>
            <GoodsCategory>
              <Name>string</Name>
              <Code>string</Code>
            </GoodsCategory>
            <StorageClass>
              <Name>string</Name>
            </StorageClass>
          </Article>
        </Articles>
      </GetArticlesByQueryResult>
    </GetArticlesByQueryResponse>
  </soap:Body>
</soap:Envelope>
+

Response specification

GetArticlesArticleInfo
ArticleDefId int Ongoing WMS internal id of the article
ArticleNumber str(100) Article number
ArticleName str(200) Article name
ProductCode str(200) Product code.
BarCode str(100) Barcode
BarCodePackage str(100) Barcode of bulk package containing this article
BarCodePallet str(100) Barcode for a pallet containing this article
QuantityPerPallet int Number of units that fit on a pallet
QuantityPerPackage int Number of units that fit in a package/box
QuantityPerLayer int Number of articles per layer on the pallet
Description str(3000) A text describing the article
SupplierArticleNumber str(200) The supplier's article number for the article
StatisticsNumber str(100) Statistics number (used for customs)
ArticleGroup obj Group
MainSupplier obj Supplier
ArticleCategory obj Category
ArticleSize obj Size
ArticleColor obj Color
ArticleUnit obj Unit
GoodsOwner obj Information about the goods owner which the article belongs to
Length dec Length (m)
Width dec Width (m)
Height dec Height (m)
Price dec Price
Weight dec Weight (kg)
NetWeight dec Net weight (kg)
Volume dec Volume (m^3)
PurchaseCurrency obj Purchase currency
CountryOfOrigin obj Country of origin
PurchasePrice dec Purchase price
StockLimit int Minimum number of units allowed in stock
FreeDecimal1 dec Free decimal, may be used for anything
FreeDecimal2 dec Free decimal, may be used for anything
DefaultPickingLocation str(50) The article's default picking location
DefaultPickingLocationMaxNumberOfItems dec Maximum number of items which should be available in the article's default picking location
DefaultPickingLocationStockLimit dec Minimum number of items which should be available in the article's default picking location
ArticleKind enum An enum describing what kind of article this is:
  • Stock - normal article, which can be kept in stock
  • Production - an article which is produced by the warehouse
  • Structure - an article which is defined in terms of other articles
  • NonStock - an article which is not kept in stock, e.g. an article which represents "freight"
MaxStackNumberOfLevels dec If the article is stackable, this represents the maximum number of levels in such a stack.
GoodsCategory obj Goods category
StorageClass obj Used for classifying articles in different storage classes based on velocity. Also known as "ABC class".