Module endpoint.ArtikelListe
ArtikelListe - CASYMIR REST API Standard Endpunkt ArtikelListe
Methods
| Methods |
Request GET ArtikelListe
| GET-Request-Field-Definition | |
| GET-Request-Usage | |
| GET-Response-Field-Definition | |
| GET-Response |
ArtikelListe-Request-Handler (Internal)
| ArtikelListe (DB, EndUrl, Pattern, Methode, UserName, QueryStr, Bodytable) | Endpunkt Handler. |
Methods
Request GET ArtikelListe
- GET-Request-Field-Definition
-
Fields:
- waehrabk char(4) -- Währung für die Preisausgabe ISO 4217 default [Leitwährung] (optional)
- debinr char(6) -- DebiNr des Kunden default [null] (optional)
- limit int -- Ausgabe der X Artikel default [0 (Unbegrenzt)] (optional)
- offset int -- Ausgabe ab Artikel X default [0] (optional)
- fields string -- Beschränkt die Auswahl auf die Felder z.B ArtNr,ArtBez (optional)
- sorts string -- Die Feldinhalte durch voranstellen mit + und - sortiert werden, z.b -ArtNr,+ArtBez default [+ArtBez] (optional)
- adrsprache char(4) -- Sprache zur Ausgabe, debinr Sprache Primär ISO-639-2B default [ger] (optional)
- GET-Request-Usage
-
Usage:
GET /www/artikel GET /www/artikel?fields={fields}&sorts={sorts} GET /www/artikel?fields={fields} GET /www/artikel?sorts={sorts} GET /www/artikel?offset={offset}&limit={limit} -- ?limit=50&offset=0 GET /www/artikel?waehrabk={waehrabk}&debinr={debinr} - GET-Response-Field-Definition
-
Fields:
- ArtNr char(15) -- Artikelnummer
- AnLager char(1) -- J=Ja, N=Nein, Lagergeführt
- ArtBez varchar(255) -- Artikelbezeichnung
- ArtikelStatus int -- 1=Aktiv, ...
- Einheit varchar(12) -- Artikel-Einheit
- Farbe varchar(12) -- Artikel-Farbkennzeichnung #rrggbb im Casymir (Die Kennzeichnung ist nicht die Farbe des Artikels)
- WUSTSatz float -- Steuersatz der Hinterlegt ist, Fallback Standard Steuersatz
- GeaendertAmUTC string -- Zeitangabe der letzten Modifikation
- attributes table -- Attribute zum Artikel (optional)
- Contents varchar(200) -- Inhalt
- PHKey varchar(12) -- Eindeutige Bezeichnung
- links table -- Verlinkungen
- href varchar(2048) -- Verweis
- type varchar(2048) -- type des Verweis
- rel varchar(2048) -- relation des Verweis
- ArtGruppe varchar(12) -- Artikelgruppe
- HatVPE char(1) -- Verpackungen J = Ja, N = Nein
- ArtKlasse char(8) -- Artikel Klasse
- WaehrAbk char(4) -- Währungs Abkürzung ISO Format
- BeschaffungsArt char(1) -- Beschaffungs Art des Artikels
- Gewicht float -- Umrechnungsfaktor Artikel zu VPE Gewicht
- VPEGewicht float -- Gewicht der VPE
- GewichtInhalt float -- Gewicht des Inhaltes der VPE
- VPBezeichnung string -- Bezeichnung der Verpackung (optional)
- VerarbeitungsArt char(1) -- Verarbeitungs Art
- Verpackungen table -- Verpackungen zu den Artikel verknüpft mit HatVPE = J
- Preis table -- Staffel Preis Liste Das Feld fehlt wenn kein Preis Hinterlegt ist (optional)
- Bestand table -- Auflistung der Bestände nach Abzug der Reservationen in den Freigebenen Lagern (optional)
- AbAnzahl float -- Ab Anzahl Gültigkeit Preis
- BisAnzahl float -- Gültigkeit Preis
- PreisList float -- Listen Preis in WaehrAbk
- Preisart char(1) -- 'N' Netto 'B' Brutto Angabe in welcher Preisart die Preisliste geführt wird.
- LagerOrt string -- Lagerort Bezeichnung
- StaoNr int -- Standort Nummer
- LagerBestand int -- Bestand am Lager nach Abzug der Reservation, Achtung: Negative Wert ist möglich
- GET-Response
-
Usage:
GET /www/artikel?fields=ArtNr%2CAnLager%2CArtBez%2CArtikelStatus%2CEinheit%2CFarbe&sorts=%2BArtBez&limit=3&offset=2 HTTP/1.1 { "data": [ { "Einheit": "stk", "HatVPE": "N", "WaehrAbk": "CHF", "links": [ { "rel": "artikel", "type": "GET", "href": "https://casyrest.opag.loc/www/artikel/H203" }, { "rel": "artikelmedia", "type": "GET", "href": "https://casyrest.opag.loc/www/artikelmedia/H203" } ], "Bestand": [ { "LagerOrt": "ff", "StaoNr": 1, "LagerBestand": 295 }], "ArtNr": "H203", "WUSTSatz": 7.7, "ArtikelStatus": 1, "ArtBez": "Mausmatten, FN, farbig bedruckt", "GeaendertAmUTC": "2022-07-22T15:35:01Z", "Preis": [ { "GeaendertAmUTC": "2022-07-25T13:24:34Z", "AbAnzahl": 0, "BisAnzahl": 59.9999, "PreisList": 5, "Preisart": "N" }, { "GeaendertAmUTC": "2022-07-25T13:24:34Z", "AbAnzahl": 60, "BisAnzahl": 119.9999, "PreisList": 4.9, "Preisart": "N" }, { "GeaendertAmUTC": "2022-07-25T13:24:34Z", "AbAnzahl": 120, "BisAnzahl": 179.9999, "PreisList": 4.8, "Preisart": "N" }, { "GeaendertAmUTC": "2022-07-25T13:24:34Z", "AbAnzahl": 180, "BisAnzahl": 239.9999, "PreisList": 4.7, "Preisart": "N" }, { "GeaendertAmUTC": "2022-07-25T13:24:34Z", "PreisList": 4.6, "AbAnzahl": 240, "Preisart": "N" } ], "AnLager": "J" }, { "Einheit": "kg", "HatVPE": "J", "WaehrAbk": "CHF", "links": [ { "rel": "artikel", "type": "GET", "href": "https://casyrest.opag.loc/www/artikel/P206" }, { "rel": "artikelmedia", "type": "GET", "href": "https://casyrest.opag.loc/www/artikelmedia/P206" } ], "Verpackungen": [ { "Preis": [ { "GeaendertAmUTC": "2022-11-22T10:07:53Z", "AbAnzahl": 0, "BisAnzahl": 99.9999, "PreisList": 2.65, "Preisart": "N" }, { "GeaendertAmUTC": "2022-11-22T10:07:53Z", "AbAnzahl": 100, "BisAnzahl": 499.9999, "PreisList": 2.61, "Preisart": "N" }, { "GeaendertAmUTC": "2022-11-22T10:07:53Z", "PreisList": 2.55, "AbAnzahl": 500, "Preisart": "N" } ], "VPEGewicht": 120, "GewichtInhalt": 100, "Gewicht": 0.1, "VPBezeichnung": "Glasflasche 100ml", "VPEinheit": "gf100ml" }, { "Preis": [ { "GeaendertAmUTC": "2022-11-22T10:07:53Z", "AbAnzahl": 0, "BisAnzahl": 99.9999, "PreisList": 0.335, "Preisart": "N" }, { "GeaendertAmUTC": "2022-11-22T10:07:53Z", "AbAnzahl": 100, "BisAnzahl": 499.9999, "PreisList": 0.311, "Preisart": "N" }, { "GeaendertAmUTC": "2022-11-22T10:07:53Z", "PreisList": 0.288, "AbAnzahl": 500, "Preisart": "N" } ], "VPEGewicht": 15, "GewichtInhalt": 10, "Gewicht": 0.01, "VPBezeichnung": "Glasflasche 10ml", "VPEinheit": "gf10ml" } ], "GeaendertAmUTC": "2022-01-02T13:38:22Z", "ArtikelStatus": 1, "ArtNr": "P206", "ArtBez": "Stimorol® KM", "AnLager": "J" }, { "Einheit": "kg", "HatVPE": "N", "WaehrAbk": "CHF", "Farbe": "#f3f1eb", "links": [ { "rel": "artikel", "type": "GET", "href": "https://casyrest.opag.loc/www/artikel/C001" }, { "rel": "artikelmedia", "type": "GET", "href": "https://casyrest.opag.loc/www/artikelmedia/C001" } ], "ArtNr": "C001", "WUSTSatz": 7.7, "attributes": [ { "Contents": "A00,A04,A10,A13,A25,A27,A30", "PHKey": "B_ATTRIBUTE" }, { "Contents": "N", "PHKey": "GEFAHRGUT" }, { "Contents": "F", "PHKey": "P_ERMITTLUNG" }, { "Contents": "ArtPreisErmittelnAnz_ZGO", "PHKey": "P_FORMELNAME" }, { "Contents": "Artikel,C", "PHKey": "RESTWEBSHOP" } ], "ArtikelStatus": 1, "GeaendertAmUTC": "2021-11-25T14:13:27Z", "ArtBez": "Kochsalz", "AnLager": "J" } ], "links": [ { "rel": "next", "type": "GET", "href": "https://casyrest.opag.loc/www/artikel?offset=4&sorts=+ArtBez&limit=2&waehrabk=CHF&debinr=123456&fields=ArtNr,AnLager,ArtBez,ArtikelStatus,Einheit,Farbe" }, { "rel": "prev", "type": "GET", "href": "https://casyrest.opag.loc/www/artikel?offset=0&sorts=+ArtBez&limit=2&waehrabk=CHF&debinr=123456&fields=ArtNr,AnLager,ArtBez,ArtikelStatus,Einheit,Farbe" }, { "rel": "start", "type": "GET", "href": "https://casyrest.opag.loc/www/artikel?offset=0&sorts=+ArtBez&limit=2&waehrabk=CHF&debinr=123456&fields=ArtNr,AnLager,ArtBez,ArtikelStatus,Einheit,Farbe" } ] }
ArtikelListe-Request-Handler (Internal)
- ArtikelListe (DB, EndUrl, Pattern, Methode, UserName, QueryStr, Bodytable)
-
Endpunkt Handler.
Artikel-Attribut: Einstellbar PHKey verwaltung REST Schnitstelle z.B. RESTWEBSHOP Artikel-Attribut: WEBSHOPVPE Fix wert * Artikel Attribut RESTWEBSHOP == WERT wie Beim RESTUser * Artikel Attribut WEBSHOPVPE Komma getrennte Liste der VPE welche ausgegeben werden im REST, Leer = alle * PLType FallBack DebiNr PLType -> auf Variable RESTPreisliste Preis Ermittlung erfolgt pro Artikel/VPE im Fallback Verfahren, wenn es einen Treffer gibt wird dieser ausgegeben. Ein Merge aus mehreren Preislisten erfolgt nicht.
Parameters:
- DB UserData Datenbank Verbindung
- EndUrl string Enthält die Ausgelesene URI aus der Datenbank
- Pattern string Enthält den Pallter Teil der URI else nil
- Methode string HTTP Methode
- UserName string Benutzer der Angemeldet wurde
- QueryStr string Orginal String ohne Hex Zeichen
- Bodytable table -- Request Body
Returns:
-
table
retBody