Module endpoint.Artikel

Artikel - CASYMIR REST API Standard Endpunkt Artikel

Methods

Methods

Request GET Artikel

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

Artikel-Request-Handler (Internal)

Artikel (DB, EndUrl, Pattern, Methode, UserName, QueryStr, BodyTable) Endpunkt Handler.


Methods

Methods

Usage:

    GET

Request GET Artikel

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:

  • 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
  • WUSTSatz float -- Steuersatz der Hinterlegt ist, Fallback Standard Steuersatz
  • GeaendertAmUTC string -- Zeitangabe der letzten Modifikation
  • ArtGruppe char(12) -- Artikelgruppe
  • ArtKlasse char(8) -- Artikel Klasse
  • WaehrAbk char(4) -- Währungs Abkürzung ISO Format
  • BeschaffungsArt char(1) -- Beschaffungsart des Artikels
  • VerarbeitungsArt char(1) -- Verarbeitungsart
  • links -- Verlinkungen
    • href varchar(2048) -- Verweis
    • type varchar(2048) -- Type des Verweises
    • rel varchar(2048) -- Relation des Verweises

      -- Attributes

  • attributes -- Attribute zum Artikel
    • Contents varchar(200) -- Inhalt
    • PHKey varchar(12) -- Eindeutige Bezeichnung
  • HatVPE char(1) -- Verpackungen Ja/Nein Ohne VPE erfolgt die Anzeige des Preises und Bestands direkt.

    -- Verpackungen

  • Verpackungen -- Verpackungen zum Artikel, verknüpft mit HatVPE = J
    • VPEEANNr varchar(30) -- EAN der Verpackung
    • VPBezeichnung string -- Bezeichnung der Verpackung (optional)
    • Gewicht float -- Umrechnungsfaktor Artikel zu VPE Gewicht
    • VPEGewicht float -- Gewicht der VPE
    • GewichtInhalt float -- Gewicht des Inhalts der VPE

      -- Preisstaffel

    • Preis table -- Staffelpreis Liste (Feld fehlt, wenn kein Preis hinterlegt) (optional)
    • Preis.ArtNr char(15) -- Artikelnummer
    • Preis.Bereich char(15) -- Preisbereich
    • Preis.AbAnzahl float -- Ab Anzahl Gültigkeit des Preises
    • Preis.BisAnzahl float -- Bis Anzahl Gültigkeit des Preises
    • Preis.PreisList float -- Listenpreis in WaehrAbk
    • Preis.Preisart char(1) -- 'N' Netto 'B' Brutto
    • Preis.VPEinheit varchar(30) -- Verpackungseinheit ID-Code
    • Preis.GeaendertAmUTC string -- Zeitangabe der letzten Modifikation
    • Preis.links table -- Verlinkungen
    • Preis.links.href varchar(2048) -- Verweis
    • Preis.links.type varchar(2048) -- Type des Verweises
    • Preis.links.rel varchar(2048) -- Relation des Verweises

      -- Bestände

    • Bestand table -- Auflistung der Bestände nach Abzug der Reservationen in den Freigebenen Lagern (optional)
    • Bestand.ArtNr char(15) -- Artikelnummer
    • Bestand.LagerOrt string -- Lagerort Bezeichnung
    • Bestand.StaoNr int -- Standortnummer
    • Bestand.LagerBestand int -- Bestand nach Abzug der Reservation (negativer Wert möglich)
    • Bestand.VPEinheit varchar(30) -- Verpackungseinheit ID-Code
    • Bestand.Bereich char(15) -- Bestandsbereich
    • Bestand.links table -- Verlinkungen
    • Bestand.links.href varchar(2048) -- Verweis
    • Bestand.links.type varchar(2048) -- Type des Verweises
    • Bestand.links.rel varchar(2048) -- Relation des Verweises
  • Deklaration -- Ausgabe des Ursprungserklärung/Deklaration des Artikels
    • Nr int -- Eindeutige Zuordnungsnummer
    • AdrSprache varchar -- Sprache zur ISO-639-2B
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-Request-Handler (Internal)

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 retBody
generated by LDoc 1.4.6 Last updated 2025-04-28 17:58:45