Bestandsdaten [ccb by dsb®

Diese Seite beschreibt die REST Web Services zu Bestandsdaten.

GetStockInfoComplete

Dieser Service liefert die Bestände der Lagerartikel.

In VHS können Artikel, bei denen bekannt ist, dass der in VHS hinterlegte Bestand nicht korrekt ist, markiert werden. diese werden dann von diesem Service nicht geliefert.

Path mapping(intern): /net/dsb/vhs3/StockInfo/getStockInfoComplete-1.0.0
Korrespondierender SOAP Service: getStockInfoComplete.

URL

GET: /rest/{client}/stockinfo

Parameter	Beschreibung
client	Mandantennummer
sp	Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.)
plants	Liste der Werke, die abgefragt werden sollen (optional, default: alle)
fromHit	Position des ersten Artikels, der zurück geliefert werden soll. (optional, default: 1)
maxHits	maximale Anzahl der zurückgelieferten Artikel. (optionl, default: alle)

Wenn die Ergebnismenge zu groß wird, dann bricht der Request mit Timeout ab. Dann muss mit den Parametern fromHit und maxHits abschnittsweise gelesen werden.

Ergebnis

Das Ergebnis ist ein JSON Dokument mit allen Beständen.

JSON StockInfo

Example

<code json> {

  "stockArticleNumber": "4711",
  "stockArticleNumberExternal": "4711-1",
  "stockArticleDescription": "FENSTERSCHEIBE",
  "stocks": [
    {
      "stockPlant": "1",
      "stockAvailable": 9741,
      "stockBlocked": 0,
      "stockReturned": 0,
      "stockDamaged": 0,
      "stockReserved": 0,
      "stockAvailableFree": 9741
    }
  ],
  "stockAvailableSum": 9741,
  "stockAvailableFreeSum": 9741,
  "stockBlockedSum": 0,
  "stockReturnedSum": 0,
  "stockDamagedSum": 0,
  "stockReservedSum": 0

}

Element Definitions

Field name	Type	Description
stockArticleNumber	C	Lagerartikelnummer
stockArticleNumberExternal	C	externe Lagerartikelnummer
stockArticleDescription	C	Beschreibung des Lagerartikels
stocks		Array mit Bestandinformationen zu jedem Werk
stockPlant	C	Kennung des Werkes
stockAvailable	N	Anzahl vorhandener Artikel.
stockAvailableFree	N	Anzahl der frei verfügbaren Artikel. Dies ist die Anzahl der vorhandenen Artikel abzüglich der reservierten Artikel.
stockBlocked	N	Bestand im Sperrlager
stockReturned	N	Bestand im Retourenlager
stockDamaged	N	Bestand im Defektenlager
stockReserved	N	Anzahl reservierter Artikel oder Rückstände
stockAvailableSum	N	Summe der vorhandenen Artikel in allen Werken
stockAvailableFreeSum	N	Summe der frei verfügbaren Artikel. Dies ist die Anzahl der vorhandenen Artikel abzüglich der reservierten Artikel in allen Werken
stockBlockedSum	N	Summe der Artikel im Sperrlager in allen Werken
stockReturnedSum	N	Summe der Artikelim Retourenlager in allen Werken
stockDamagedSum	N	Summe der Artikelim Defektenlager in allen Werken
stockReserved	N	Summe der reservierten Artikel oder Rückstände in allen Werken