getStockInfoSummarized

This method returns the amount of times a distribution article can be sold. All types of articles are taken into account, these being: Set Articles, Virtual Articles, Standard Articles. Other attributes that are taken into account are the reservation of stock (which are taken away from the total amount) and multiple stock-plants (where the totals are added together). A result less than 0 (due to reservations) will return 0.

Artices that are known to have an incorrect stock can be marked in VHS. These article are not returned by this service.

Note

Because of the many-to-one relationship between Distribution Articles and Stock Articles there is the danger that a client could misinterpret the results of this method and total all the stock-available-sum values. This may result in the client summarizing that they have more stock than they actually physically have. To calculate the physical stock, the client must use the getStockInfo method.

Example 1: One-to-one relationship between Distribution and Stock Article.

DistributionArticle-Nr.	StockArticle-Nr.	Physical stock	Reservation	Result
1234	1234	2	0	2
1234	1234	2	1	1
1234	1234	2	2	0
1234	1234	2	5	0

Example 2: Many-to-one relationship between Distribution and Stock Articles. Note that by totaling the stock-available-sum you would risk having invalid results as the Distribution Articles reference the same Stock Article: in the first case you would get 4 when only 2 Articles are physically stored.

DistributionArticle-Nr.	StockArticle-Nr.	Physical stock	Reservation	Result
1111	1111	2	0	2
2222	1111	2	0	2
1111	1111	2	3	0
2222	1111	2	3	0

Example 3: Set Artikel.

When the set article is queried, the stock-available-sum will be, how often the set as a whole can be sold. When one article of the set becomes out of stock, the stock-availablesum will also be 0. Here, there is also the danger that when the client totals the stockavailable-sum, they will get invalid results.

DistributionArticle-Nr.	Set Parts	Amount in Set	StockArticle-Nr.	Phys. Bestand	Reservation	Result
1111	2222	1	2222	5	0	4
	3333	2	3333	10	0
	4444	3	4444	14	0

1111	2222	1	2222	5	0	0
	3333	2	3333	10	0
	4444	3	4444	14	19

Object: /net/dsb/vhs3/StockInfo
Method: getStockInfoSummarized
Version: 1.0.0

Parameter

Name	Type / Lenght	Opt. / Mandat.	Description
distribution-article-number	AN / 13	(M)	distribution-article-number
search	XML	(M) B	In case all the article numbers need to be returned, they can be retrieved in blocks.
filter-for-article-type	AN / 1	O	Article type 1= stock item 2=Pseudo/setarticle(distribution article) 3=service
filter-for-article-status	N / 5	O	Filters based upon article status
from-hit	N / 5	(M)B	The amount of articles that should be returned. The maximum is 100.
max-hit-count	N / 5	(M)B	The amount of articles that should be returned. The maximum is 100.

Response Element

stock available free sum, according to requested 'distribution-article-number'

Example Request

<?xml version="1.0" encoding="UTF-8"?>
<message version="1.0" system="vhs/3" >
  <header>
    <client>4711</client>
    <service-provider>999</service-provider>
  </header>
  <body>
    <search>
      <filter-for-article-status>1</filter-for-article-status>
      <filter-for-distribution-article-number>\w{13}</filter-for-distribution-articlenumber>
      <from-hit>1</from-hit>
      <max-hit-count>100</max-hit-count>
    </search>
  </body>
</message>

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<message version="1.0" system="vhs/3">
  <header>
    <client>4711</client>
    <service-provider>999</service-provider>
  </header>
  <body>
    ...
    <stock-available-free-sum distribution-article-number="300053984200">13</stock-available-free-sum>
    ...
  </body>
</message>