Die CATAMA API für Bestandsdaten (Artikel, AW, etc.), gibt Ihnen die Daten als JSON zurück und antwortet mit den Keys “data” (mit den Bestandsdaten), dem Feld “status” (1 oder 0) für den Erfolg des Abrufs sowie einer Nachricht “message” die ggf. eine Fehlermeldung enthält. Die Funktion steht für CATAMA Enterprise Unlimited Instanzen zur Verfügung.

GET – Zum Auslesen sämtlicher Bestandsdaten

Endpunkt:
https://ihre-catama-url/api/inventory/list

Pflichtparameter:
token – String = Token für den API-Aufruf

Optionale Parameter:
offset – Integer = Angabe ab welchem Datensatz die Datenselektion erfolgen soll (nur in Kombi mit take)
take – Integer = Anzahl an Datensätzen, die selektiert werden sollen (nur in Kombi mit offset)
statusid – Integer = Filteroption nach dem Bestands-Status (aktiv = 1, inaktiv = 2) – Default = 1

Beispiel – Abruf der Daten für sämtlicher Bestandsdaten
https://ihre-catama-url/api/inventory/list?token=IHRGEHEIMERCATAMATOKEN

Beispiel – Abruf der Daten für Bestände ab dem 10. Datensatz (offset = 10), mit maximal 10 Datensätzen als Rückgabe-Inhalt (take=10) übergeben
https://ihre-catama-url/api/inventory/list?token=IHRGEHEIMERCATAMATOKEN&take=10&offset=10

Filter nach Type-ID (am Beispiel von statusid=2 für inaktive Artikel)
https://ihre-catama-url/api/inventory/list?token=IHRGEHEIMERCATAMATOKEN&statusid=2

GET – Zum Auslesen spezifischer Bestandsdaten

Endpunkt:
https://ihre-catama-url/api/inventory/byid

Pflichtparameter:
id – Integer = ID des Datensatzes (ID)
token – String = Token für den API-Aufruf

Beispiel – Abruf der Daten für Artikel mit ID 1
https://ihre-catama-url/api/inventory/byid?id=1&token=IHRGEHEIMERCATAMATOKEN