identpro Logo
← Übersicht
Interface-Beschreibung

Neue HU anlegen,
ohne Auftrag

TORD Transaktion: AVIS
WMS REST Interface

1. Überblick

Dieser Prozess beschreibt die Anlage einer neuen Handling Unit (HU / Ladung) in identpro WES über das WMS-REST-Interface, ohne gleichzeitig einen Transportauftrag zu erstellen. Die Transaktion wird als AVIS (Transaktionstyp tatyp = "AVIS") bezeichnet.

Nach erfolgreicher Verarbeitung steht die Ladung in identpro WES als eigenständiger Bestand zur Verfügung und kann für spätere Transportaufträge (z. B. INBO, OUTB, REAR) verwendet werden. Optional kann die Ladung bei der Anlage direkt einer Lagerposition zugewiesen werden (topla).

2. Beteiligte Systeme

SystemRolleAktion
LVS / WMS Auftraggeber Sendet den AVIS-Request; empfängt und verarbeitet die Response
identpro WES Empfänger Validiert Daten, legt Ladung an, weist optional Location zu, antwortet mit Status
Stapler / Ressource Ausführend Befördert die physische Ladung; der neue Bestand ist im System hinterlegt

3. Voraussetzungen

4. Prozessablauf

LVS / WMS
identpro WES
Stapler
1LVS erstellt den AVIS-Request mit allen Ladungsdaten (Ladungs-ID, Typ, Dimensionen, Pakete, optionale Location).
2LVS sendet HTTP PUT an https://<HOST>:<PORT>/wms/idptords mit dem JSON-Array im Request-Body.
3identpro WES empfängt die Anfrage und prüft die Eingabedaten (Pflichtfelder, Datentypen, Systemkonfiguration).
4aFehlerfall: Validierung schlägt fehl → WES gibt status: "FAIL" mit spezifischem stCode zurück. Prozess endet.
4bErfolgsfall: Ladung wird in der Datenbank angelegt. Sofern topla angegeben ist, wird die Ladung der Location zugewiesen und eingebucht.
5identpro WES antwortet mit status: "OK", stCode: 0 und einem Bestätigungstext.
6LVS verarbeitet die Response und aktualisiert den eigenen Bestand entsprechend.
7Stapler kann die Ladung anschließend im System sehen und befördert die physische Einheit zum Lagerplatz.

5. API-Aufruf

Endpunkt

MethodePUT
URLhttps://<HOST>:<PORT>/wms/idptords
Content-Typeapplication/json
Acceptapplication/json
Hinweis: Der Endpoint /wms/idptords (Plural) erlaubt die gleichzeitige Übermittlung mehrerer TORD-Objekte als JSON-Array. Für einzelne Objekte kann alternativ /wms/idptord (Singular) ohne Array verwendet werden.

Request-Body (Beispiel)

[
  {
    "tatyp":    "AVIS",
    "lenum":    "Ladung 1234",
    "topla":    "FT-01",
    "shipment": "",
    "letyp":    "Europalette",
    "length":   1200,
    "width":    800,
    "height":   1000,
    "weight":   1120,
    "lckstate": "NOT_LOCKED",
    "params": {
      "Name":     "Andreas",
      "Kollegen": "Kai und Rene"
    },
    "packageList": [
      {
        "matnum": "10070/20",
        "mattxt": "Material 1",
        "qunit":  "ST",
        "quant":  500.5,
        "weight": 999.12,
        "batch":  "Batch 1"
      }
    ]
  }
]

Pflichtfelder

FeldTypBeschreibung
tatypStringTransaktionstyp: muss "AVIS" sein
lenumStringEindeutige Ladungs-ID; darf noch nicht im System existieren
letypStringLadungstyp (muss in WES konfiguriert sein, z. B. "Europalette")
lengthIntegerLänge der Ladung in mm (Mindestwert: 1)
widthIntegerBreite der Ladung in mm (Mindestwert: 1)
heightIntegerHöhe der Ladung in mm (Mindestwert: 1)

Optionale Felder (Auswahl)

FeldTypBeschreibung
toplaStringZiel-Location; Ladung wird direkt dort eingebucht
weightIntegerGewicht der Ladung in kg
lckstateEnumSperrstatus: NOT_LOCKED, QA_LOCK, LOCKED, OTHERS
Standard: NOT_LOCKED
paramsMapZusätzliche Key-Value-Paare; auf dem Stapler-Terminal anzeigbar
packageListArrayMaterialliste der Ladung (matnum, mattxt, quant, weight, batch, …)
shipmentStringZugehörige Sendung (Shipment-Name)
descStringFreitextbeschreibung der Ladung

6. Response

Jede Antwort von identpro WES enthält die folgenden drei Felder:

FeldTypBeschreibung
statusString"OK" – Anfrage erfolgreich verarbeitet
"FAIL" – Anfrage fehlgeschlagen
stCodeIntegerSpezifischer Statuscode (s. Abschnitt 7)
sftxtStringKlartext-Beschreibung des Ergebnisses oder der Fehlerursache

Beispiel – Erfolgsfall

✓ Response OK
{
  "status": "OK",
  "stCode": 0,
  "sftxt":  "[tatyp:AVIS, deliv: null]: AVIS accepted, load with lenum Ladung 1234 was created."
}

Beispiel – Fehlerfall (Ladung bereits vorhanden)

✗ Response FAIL
{
  "status": "FAIL",
  "stCode": 104,
  "sftxt":  "Load with name 'Ladung 1234' already exists!"
}

7. Statuscodes

stCodeBedeutungUrsache / Beschreibung
0 Erfolg Ladung wurde erfolgreich angelegt und (optional) der Location zugewiesen.
100 Allgemeiner Fehler Business-Logik-Fehler, z. B. ungültige Lagertyp-Konfiguration im Materialfluss.
101 Unvollständige Daten lenum ist leer/null; letyp fehlt; Dimensionen (length, width, height) sind nicht gesetzt.
102 Ungültige / unbekannte Daten Angegebene Location (topla) existiert nicht in WES; letyp ist unbekannt; Dimensionswert ist ≤ 0.
104 Datensatz existiert bereits Eine Ladung mit dem angegebenen lenum ist bereits im System vorhanden.
107 Material unbekannt Ein Material aus der packageList ist nicht in WES hinterlegt und die automatische Materialanlage ist deaktiviert.

8. Hinweise

Mehrere Ladungen in einem Request:
Der Endpoint /wms/idptords akzeptiert ein JSON-Array mit beliebig vielen TORD-Objekten. Alle Objekte werden in einer gemeinsamen Transaktion verarbeitet. Tritt bei einem Objekt ein Fehler auf, schlägt der gesamte Request fehl.
Lagerplatz-Zuweisung:
Wird topla übergeben, wird die Ladung nach der Anlage direkt in die angegebene Location eingebucht. Ist die Location in WES nicht vorhanden, wird stCode 102 zurückgegeben und die Ladung wird nicht angelegt.
Sperrstatus (lckstate):
Wird kein Sperrstatus übermittelt, verwendet identpro WES den Standardwert NOT_LOCKED. Gültige Werte: NOT_LOCKED, QA_LOCK, LOCKED, OTHERS.
Materialliste (packageList):
Jede Position in der packageList erfordert mindestens das Feld matnum (Materialnummer). Alle weiteren Felder (mattxt, quant, weight, batch, packid, suppid) sind optional.