Standard-Adresse ermitteln

Keine

Die Antwort besteht aus 2 Objekten: der Lieferadresse (deliveryAddress) sowie der Rechnungsadresse (billingAddress), die jeweils gleich aufgebaut sind.

Relevante Felder umfassen:

Name1 – Adresszeile 1 (entspricht ADR1)

Name2 – Adresszeile 2 (entspricht ADR2)

Name3 – Adresszeile 3 (entspricht ADR3)

Name4 – Adresszeile 4 (entspricht ADR4)

countryName – Ländername

countryNumber – Ländernummer

plz – Postleitzahl

place – Ort

street – Straße

Teilesuche

String searchString, String transaction

Als Rückgabe kommt ein Objekt header sowie table zurück. Relevant ist hier insbesondere das "table"-Objekt.

Es wird zunächst ein "rows"-Array definiert, bei dem jede "row" einer Zeile eines Listprogramms in oxaion entspricht.

Jede "row" kann wiederum über mehrere "cells" verfügen, die in oxaion über das Programm "Sichten" gesteuert werden können.

Innerhalb der "cells" stehen die eigentlichen Informationen aus oxaion:

Relevante Parameter innerhalb der "cells" umfassen:

name: der Name des Feldes wie es in der Datenbank steht (vorangestellt die Datenbanktabelle, in der das Feld steht.
Beispiel: UTLSTP.TLIDNR – In diesem Fall liegt das Feld TLIDNR (Teileidentifikation) aus der Datenbanktabelle UTLSTP (Teilestamm) vor.)

value: Der Wert des Felds in der Datenbanktabelle

Relevante Felder umfassen:

TLIDNR – Teileidentifikation (Name des Teils)

TLBEZG – Teilebezeichnung (Beschreibung des Teils)

TLBESL – Beschaffungsschlüssel

TLDPKZ – Disponent

TLLAGO – Lagerort

TLTAKZ – Teileart (Bsp.: Baugruppe)

TLTLGR – Teilegruppe (Bsp.: Handelsware)

TLVEST – Kennzeichen Verkaufsstückliste

TLTEDT – Datum der Erfassung

Sollten weitere Informationen benötigt werden, kann dies über das entsprechende Listprogramm innerhalb der "Sichten" in oxaion gesteuert werden.

Neben dem zu suchenden Artikel bzw. Teil wird hier auch noch die Transaktion (*FIRSTLIST oder *NEXTLIST) mitgegeben. Hintergrund ist, dass nicht auf einen Schlag alle Artikel aus dem Teilestamm zurückgegeben werden können, da die Verbindung aus zeitlichen Gründen ansonsten abbricht.

Dementsprechend muss zunächst ein *FIRSTLIST aufgerufen werden, über den die ersten X Teile zurückgegeben werden. Die Anzahl an Sätzen, die zurückgeliefert werden, werden client-seitig gesteuert. Aus Performance-Gründen sollte sie nicht über 50 liegen. Falls noch weitere Teile aufgelistet werden sollen, die zu dem "searchString" passen, können diese über die *NEXTLIST-Transaktion ermittelt werden.

Aufruf der Verfügbarkeitsprüfung für ein übergebenes Teil und Menge

String article, String quantity

OMENG – aktuell verfügbare Menge

XMEKZ – Mengenkennzeichen der verfügbaren Menge (z. B. PCE für Stück)

OLFWO – Lieferwoche der aktuell verfügbaren Menge

ODIDT – Gibt an, zu welchem Termin eine Menge zur Verfügung stehen wird bzw. zu welchem Termin eine Menge vorhanden sein soll, für die eine Nachfrage besteht

MABEST – Restmenge (falls, die vom Kunden geforderte Menge über der verfügbaren Menge liegt)

OMEKZ – Mengenkennzeichen Restmenge

WW_LFWO – Lieferwoche für Restmenge

WW_DIDT – Dispositionsdatum für Restmenge

IDNR – Teilenummer bzw. Artikelnummer

TIDFBZ – Teilebezeichnung

Nach den Rows und Cells werden die einzelnen Spalten im Detail beschrieben, das ist hier nicht relevant

Wird eine Menge mit mehr als 8 Stellen (ohne 2 Nachkommastellen) angegeben, wird die Eingabe vom Server als 1 interpretiert.

Setzt die Sprache, sodass alle weiteren Endpunkte ihre Ergebnisse in der übergebenen Sprache zurückgegeben

String language

Immer http-Statuscode 200

Auch wenn die übergebene Sprache nicht existiert, wird hier (Stand 2020-01-14) kein Fehler geworfen.

Anzeige der Auftragspositionen zu einem übergebenen Verkaufsauftrag

String orderNumber

Es kommt ein Objekt vom Typ ListResponse, das wiederum aus zwei Objekten besteht:

Zunächst kommt ein Objekt Header:

PSKDNR – Kundenummer

PSFINR – Filialnummer

OAZLL – Adresszeile

Darunter liegt ein Objekt Table, mit mehreren Zeilen (rows) und Spalten (cells). In den Zellen sind prinzipiell nur das Element "name" und das Element "value" relevant. Der "name" steht für den Feldnamen in der Datenbank, der "value" enthält den entsprechenden Wert

• name: PSIDNR (Name des Feldes der Teilenummer in der Datenbank)
• value: die eigentliche Teilenummer 
  • PSTLEB – Teilebezeichnung
  • PSBES1 – Bestellmenge
  • PSLFPROZ - Prozentsatz der gelieferten Menge
  • PSLFWO – Lieferwoche
  • PSGFAL – Kennzeichen Auslieferung gefährdet
  • STATW – Status Position
  • PSWUWO – Wunsch-Lieferwoche
  • PSAUNR – Auftragsnummer
  • X_OLFDM – Lieferwert
  • X_ONEPR – Nettopreis
  • PSPDKZ – Preisdimension (z. B. pro 1)
  • PSMEKZ – Mengeneinheit

Anzeige der offenen Verkaufsaufträge des angemeldeten Users

Es kommt ein Objekt vom Typ ListResponse, das wiederum aus zwei Objekten besteht:

Zunächst kommt ein Objekt Header:

KOKDNR – Kundenummer

KOFINR – Filialnummer

OAZLL – Adresszeile

Darunter liegt ein Objekt Table, mit mehreren Zeilen (rows) und Spalten (cells). In den Zellen sind prinzipiell nur das Element "name" und das Element "value" relevant. Der "name" steht für den Feldnamen in der Datenbank, der value enthält den entsprechenden Wert.

• name: KOAUNR (Name des Feldes der Auftragsnummer in der Datenbank)
• value: die eigentliche Auftragsnummer (hier im Bsp. AB11/000031)
  • KOBEDT – Datum der Bestellung
  • KOKBNR – Kundenbestellnummer
  • KONEDM – Bestellwert netto
  • X_OKURZ – Bestell-Status
  • X_OLFDM – Gesamtwert der Lieferung (sollte immer 0 sein, da bei einem offenen Auftrag noch nichts ausgeliefert wurde)
  • KOKBBZ – Kundenbestellangaben

Fügt einem Verkaufsauftrag Positionen hinzu. Ist noch kein Verkaufsauftrag vorhanden, wird dieser mit der ersten Position erzeugt.

String deliveryDate (Achtung: dieser Parameter muss in der Form YYYY-MM-DD übergeben werden), String item (das Teil bzw. der Artikel), double quantity (Bestellmenge)

Besteht aus einem OrderHeader (dem Auftragskopf):

Der OrderHeader hält die Objekte deliveryAddress (Lieferadresse), billingAddress (Rechnungsadresse) sowie folgende Felder:

shippingMethod – Versandmethode

customerOrderNr – Kundenbestellnummer

deliveryDetails1 – Lieferdetails

deliveryDetails2 – weitere Lieferdetails

customerOrderEntries – Kundenbestellangaben

email – E-Mail des zuständigen Sachbearbeiters

die Adressen enthalten folgende Felder:

name1 – Name

name2 – Name (Fortsetzung)

name3 – Name (Fortsetzung)

name4 – Name (Fortsetzung)

countryName – Land

countryNumber – Ländercode

plz – Postleitzahl

place – Ort

street – Straße

Das Order-Objekt enthält in einem Array die OrderPositions (Auftragspositionen)

Eine OrderPosition enthält folgende Felder

positionNr – Positionsnummer

item – Teilenummer bzw. Artikelnummer

quantity – Bestellmenge

deliveryDate – Lieferdatum

lieferdatumAbweichend – Wenn Artikel nicht lieferbar zu angegebenem Wunschdatum, wird dieses Kennzeichen gesetzt

positionCounter – Index für die Position in der Arraylist im OrderHeader

itemDescription – Teilebeschreibung

grossPrice – Bruttopreis

netPrice – Nettopreis

priceDimension – Preisdimension

quantityUnit – Mengeneinheit

das Order-Objekt selbst beinhaltet noch folgende Felder:

orderNr – Auftragsnummer

positionsCount – Anzahl Positionen

currency – Währung

netPrice – Nettopreis (gesamt)

netShippingCost – Versandkosten netto

Lädt die Standard-Rechnungsadresse/Lieferadresse

die Adressen enthalten folgende Felder:

name1 – Name

name2 – Name (Fortsetzung)

name3 – Name (Fortsetzung)

name4 – Name (Fortsetzung)

countryName – Land

countryNumber – Ländercode

plz – Postleitzahl

place – Ort

street – Straße

Lädt die Standard-Rechnungsadresse/Lieferadresse

Int positionNr (Index der Position im OrderHeader)

http-Status-Code 200

Speichert die Rechnungsadresse/Lieferadresse

String name1, String name2, String name3, String name4, String countryNumber, String plz, String place, String street

die Adressen enthalten folgende Felder:

name1 – Name

name2 – Name (Fortsetzung)

name3 – Name (Fortsetzung)

name4 – Name (Fortsetzung)

countryName – Land

countryNumber – Ländercode

plz – Postleitzahl

place – Ort

street – Straße

Speichert den Kopf der Verkaufsauftrages

String eMail, String customerOrderEntries, String customerOrderNumber, String deliveryDetails1, String deliveryDetails2,

Der OrderHeader hält die deliveryAddress (Lieferadresse), billingAddress (Rechnungsadresse) sowie folgende Felder:

shippingMethod – Versandmethode

customerOrderNr – Kundenbestellnummer

deliveryDetails1 – Lieferdetails

deliveryDetails2 – weitere Lieferdetails

customerOrderEntries – Kundenbestellangaben

email – E-Mail des zuständigen Sachbearbeiters

die Adressen enthalten folgende Felder:

name1 – Name

name2 – Name (Fortsetzung)

name3 – Name (Fortsetzung)

name4 – Name (Fortsetzung)

countryName – Land

countryNumber – Ländercode

plz – Postleitzahl

place – Ort

street – Straße

Verbuchen und physisches Schreiben des Auftrags

http-Status Code 200

Führt eine Preisermittlung für ein Teil durch

String article, String quantity

OBRPR – Bruttoeinzelpreis

I_IIDNR – Teilenummer

OAZLL – Adresszeile des Kunden

OSTFN – nächste Staffelmenge

OSTFL – Staffelmenge

IPFIN - Filialnummer

OPDKZDV – Preisdimension

ORADMG – Gesamtrabatt

ORASZG – Gesamt-Rabattsatz

OBEZG – Teilebezeichnung

ONEPR – Nettopreis

ORASZ – Rabattsatz

ONEPL – Kennzeichen Nettopreis Ja/Nein

ORADM – teilebezogener Rabatt

IBES1 – Bestellmenge

OMEKZ – Mengenkennzeichen

IYGLT – Gültigkeitsdatum

OPDKZBZ – Bezeichnung Preisdimension

IIDNR – Teilenummer

WESLBZ – Währungsbezeichnung

IWESL – Währung

IPKNR - Personenkontonummer

OPDKZ – Preisdimension

ONEPRG – Gesamt-Netto

Anzeige des Gesamt-Produktkatalogs

JSON kann beliebig verschachtelt sein, ist aber immer gleich aufgebaut:

Das oberste "value"-Objekt enthält die Einträge:

"hasChildren": true,

��   "key": {

      "KOPO": "0",

      "XSTW": "PK",

      "KTLG": "AK TEST KATALOG1"

    }

Durch den Eintrag hasChildren wird signalisiert, dass dieser Katalog beliebig viele Unterelemente hält

Der Katalog wird spezifiziert durch:

KOPO – Komponentenposition (nur auf oberster Ebene = 0)

XSTW – Komponentenspezifikation à mögliche Ausprägungen:

Sowie die Ausprägung "leer" à damit hat dieses Element keine weiteren Unterelemente

KTLG – Katalog

Value – enthält neben komplexen Objekten (wie weiter oben beschrieben) auch einfache Strings. Diese stellen die Katalogbezeichnungen dar.

Anzeige aller Teile eines Katalogs

String catalog, String specification (Spezifikation entspricht dem im vorherigen Endpoint beschriebenen Feld XSTW)

Es kommt ein Objekt vom Typ "Table" zurück

Eintrag "columns" kann ignoriert werden

Eintrag "rows" hält die eigentlichen Daten zu einem Artikel

Jede "row" enthält ein Objekt "key" mit…

KOPO – Komponentenposition

IDNR – Teilenummer

Außerdem enthält die row ein Array aus "cells", jedes Objekt hier besteht aus den Tags value, valueList, name

Relevant sind name und value

TLIDNR – Teilenummer

TLBEZG – Teilebezeichnung

TLMANR – Materialnummer

TLZEIC – Zeichnungsnummer

TLABME – Abmessung

Ein Artikel kann selbst wieder ein Katalog darstellen und aus weiteren Unterartikeln bestehen

Im Fehlerfall wird eine OxaionException geworfen (ohne Errorcode, da vom Server kein Errorcode zurückgegeben wird)

Login

String user, String password

http-Status-Code 200

http-Status-Code 403

Anzeige der aktuellen Anmeldeinformationen

Keine

MILKAR – Kontenart Lieferant

MIPKAR – Personenkontenart

MNDTTZ – Datumstrennzeichen

MNDTFM – Datumsformat

mailAddress – E-Mailadresse des angemeldeten Users

customerName1 – Name des angemeldeten Users

customerName2 – Name (Fortsetzung) des angemeldeten Users

MILINR – Lieferantennummer

MILFIN – Lieferantenfilialnummer

MNDCPT – Dezimalpunkt

MIKDNR – Kundennummer – über diese Nummer werden alle weiteren Endpunkte aufgerufen, d. h. Verkaufsaufträge werden auf diese Kundennummer angelegt, Preisermittlungen für diesen Kunden durchgeführt …

MIFINR – Filialnummer des Kunden

MNDCTZ – Dezimaltrennzeichen

JOB – Jobnummer des angemeldeten Users