CASYMIR REST API Standard Endpunkte

Methods

Usage:

GET

GET-Request-Field-Definition

Fields:

ArtNr char(15) -- Artikelnummer
waehrabk char(4) -- Währung für die Preisausgabe ISO 4217 default [Leitwährung] (optional)
debinr char(6) -- DebiNr des Kunden default [null] (optional)
adrsprache char(4) -- Sprache zur Ausgabe ISO-639-2B, debinr Sprache Primär default [ger] (optional)

GET-Request-Usage

Usage:

GET /www/artikel/{ArtNr}
GET /www/artikel/C202?waehrabk=EUR
GET /www/artikel/C202?waehrabk=EUR&debinr=123456
GET /www/artikel/C202?waehrabk=EUR&debinr=123456&adrsprache=eng

GET-Response-Field-Definition

Fields:

ArtGruppe char(15) -- Artikelgruppe
Einheit varchar(12) -- Artikel-Einheit
HatVPE char(1) -- N=Artikel hat keine VPE
ArtKlasse varchar(12) -- Artikel-Klassifikation
BeschaffungsArt char(1) -- Beschaffungsart
Farbe varchar(12) -- Artikel-Farbkennzeichnung #rrggbb im Casymir (Die Kennzeichnung ist nicht die Farbe des Artikels)
AnLager char(1) -- J=Ja, N=Nein, Lagergeführt
ArtikelStatus int -- 1=Aktiv, ...
VerarbeitungsArt char(1) -- C=Chargengeführt, N=Nicht chargengeführt
WUSTSatz float -- Steuersatz der Hinterlegt ist, Fallback Standard Steuersatz
attributes table -- Attribute zum Artikel (optional)
Contents varchar(200) -- Inhalt
PHKey varchar(12) -- Eindeutige Bezeichnung
Verpackungen table -- Verpackungen zu den Artikel verknüpft mit HatVPE = J
VPEinheit varchar(30) -- ID-Code
Faktor float -- Mengen-Faktor zu Grundeinheit
VPEGewicht float -- Gewicht einer VPE in X
GewichtInhalt float -- Gewicht des Inhaltes der VPE
ArtBez varchar(255) -- Artikelbezeichnung
Preis table -- Staffel Preis Liste Das Feld fehlt wenn kein Preis Hinterlegt ist (optional)
VPBezeichnung string -- Bezeichnung der Verpackung (optional)
WaehrAbk char(4) -- Währung für die Preisausgabe ISO 4217
links table -- Verlinkungen
href varchar(2048) -- Verweis
type varchar(2048) -- type des Verweis
rel varchar(2048) -- relation des Verweis
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
Deklaration table -- Ausgabe des Ursprungserklärung/Deklaration des Artikels (optional)
Nr int -- Eindeutige Zuordnungsnummer
AdrSprache varchar -- Sprache zur ISO-639-2B
ArtNr varchar -- Artikel Nr
Bezeichnung1 varchar -- Bezeichnugsfeld 1
Bezeichnung2 varchar -- Bezeichnugsfeld 2
KurzBezeichnung varchar -- Kurzbezeichnung
OrtLand varchar -- Land ISO 3166 ALPHA-2

GET-Response

Usage:

GET /www/artikel/C202 HTTP/1.1

{"data": {
   "ArtGruppe": "HCK",
   "Einheit": "stk",
   "HatVPE": "N",
   "ArtKlasse": "Handel",
   "AnLager": "J",
   "BeschaffungsArt": "H",
   "Bestand": [   {
      "LagerOrt": "ff",
      "StaoNr": 1,
      "LagerBestand": 295
   }],
   "Deklaration":       [
               {
         "KurzBezeichnung": "C201-Allgemein",
         "ArtNr": "P201",
         "Nr": 3,
         "OrtLand": "ES",
         "Bezeichnung2": "Firmenname",
         "Bezeichnung1": "The exporter of the products covered by this document (custums authorization no. 9999/9999) declares that, except where otherwise clearly indicated, these products are of Swiss preferential origin.",
         "links":             [
                           {
               "rel": "artikel",
               "type": "GET",
               "href": "https://casyrest.opag.loc/www/artikel/P201"
            },
                           {
               "rel": "artikelmedia",
               "type": "GET",
               "href": "https://casyrest.opag.loc/www/artikelmedia/P201"
            }
         ]
      },
               {
         "KurzBezeichnung": "C101-Allgemein",
         "ArtNr": "P201",
         "Nr": 6,
         "OrtLand": "CH",
         "Bezeichnung2": "Company-Name",
         "Bezeichnung1": "The exporter of the products covered by this document (custums authorization no. 9999/9999) declares that, except where otherwise clearly indicated, these products are of Swiss preferential origin.",
         "links":             [
                           {
               "rel": "artikel",
               "type": "GET",
               "href": "https://casyrest.opag.loc/www/artikel/P201"
            },
                           {
               "rel": "artikelmedia",
               "type": "GET",
               "href": "https://casyrest.opag.loc/www/artikelmedia/P201"
            }
         ]
      },
               {
         "KurzBezeichnung": "C101-Deutschland",
         "ArtNr": "P201",
         "Nr": 7,
         "OrtLand": "DE",
         "Bezeichnung2": "Company-Name",
         "Bezeichnung1": "Der Ausführer (Ermächtigter Ausführer, Bewilligungs-Nr. 9999/9999) der Waren, auf die sich dieses Handelspapier bezieht, erklärt, dass diese Ware, soweit nicht anders angegeben, präferenzbegünstigte Schweizer Ursprungswaren sind.",
         "links":             [
                           {
               "rel": "artikel",
               "type": "GET",
               "href": "https://casyrest.opag.loc/www/artikel/P201"
            },
                           {
               "rel": "artikelmedia",
               "type": "GET",
               "href": "https://casyrest.opag.loc/www/artikelmedia/P201"
            }
         ]
      }
   ],
   "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"
      }
   ],
   "WaehrAbk": "CHF",
   "ArtNr": "H203",
   "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,
   "VerarbeitungsArt": "N",
   "ArtGewicht": 12,
   "Preis":    [
            {
         "GeaendertAmUTC": "2022-07-25T15:39:17",
         "AbAnzahl": 0,
         "BisAnzahl": 59.9999,
         "PreisList": 5,
         "Preisart": "N"
      },
            {
         "GeaendertAmUTC": "2022-07-25T15:39:17",
         "AbAnzahl": 60,
         "BisAnzahl": 119.9999,
         "PreisList": 4.9,
         "Preisart": "N"
      },
            {
         "GeaendertAmUTC": "2022-07-25T15:39:17",
         "AbAnzahl": 120,
         "BisAnzahl": 179.9999,
         "PreisList": 4.8,
         "Preisart": "N"
      },
            {
         "GeaendertAmUTC": "2022-07-25T15:39:17",
         "AbAnzahl": 180,
         "BisAnzahl": 239.9999,
         "PreisList": 4.7,
         "Preisart": "N"
      },
            {
         "GeaendertAmUTC": "2022-07-25T15:39:17",
         "PreisList": 4.6,
         "AbAnzahl": 240,
         "Preisart": "N"
      }
   ],
   "ArtBez": "Mausmatten, FN, farbig bedruckt"
}}

Artikel (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 Patter 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

CASYMIR REST API

Contents

Modules

Topics

Module `endpoint.Artikel`

Methods

Request GET Artikel

Artikel-Request-Handler (Internal)

Methods

Usage:

Request GET Artikel

Fields:

Usage:

Fields:

Usage:

Artikel-Request-Handler (Internal)

Parameters:

Returns:

GET-Request-Field-Definition
GET-Request-Usage
GET-Response-Field-Definition
GET-Response

CASYMIR REST API

Contents

Modules

Topics

Module endpoint.Artikel

Methods

Request GET Artikel

Artikel-Request-Handler (Internal)

Methods

Usage:

Request GET Artikel

Fields:

Usage:

Fields:

Usage:

Artikel-Request-Handler (Internal)

Parameters:

Returns:

Module `endpoint.Artikel`