Zum Hauptinhalt springen

​
Authentifizierung

Jede Anfrage enthält Authorization: Bearer <api-key>. Basis-URL: https://dashboard.scango.ch/api/v1.

​
Produkt per Barcode oder Name finden

GET /products mit Abfrageparameter q (Volltextsuche). Stabile Kennung: listProducts. 
GET /products?q=7610800001234&limit=50
Treffer stehen in data[]; die Produkt-ID steht in id. meta liefert total/returned und den angewendeten limit (Standard 100; bei Suche mit q außerdem offset, effektive Obergrenze 250).

​
Mehr Einträge listen

GET /products, GET /orders, GET /suppliers und GET /categories akzeptieren limit (Standard 100, Maximum 5000). Erhöhen Sie limit oder nutzen Sie bei der Produktsuche offset, wenn Sie weitere Seiten brauchen.

​
Produktdetails laden

  1. Produkt-ID aus der Suche oder aus Ihrem System verwenden.
  2. GET /products/{productId} — getProduct
Antwort: { "data": { ... } }.

​
Bestellungen im Zeitraum

GET /orders mit start und end als ISO-8601-Zeitstempel — listOrders. Für aktuelle Daten in Intervallen abfragen; Webhooks sind derzeit nicht verfügbar (siehe Einführung).

​
Bestellung mit Positionen

GET /orders/{orderId} — getOrder für eine einzelne Bestellung inkl. products.

​
Fehlerantworten

CodeBedeutung
400Ungültige Abfrage oder Body; oft { "error": { "formErrors": [], "fieldErrors": { ... } } } (ValidationErrorResponse)
403Fehlender/ungültiger Schlüssel, inaktiver Schlüssel oder fehlende Berechtigung
503z. B. Produktsuche vorübergehend nicht verfügbar
Häufig enthält die Antwort ein String-Feld error (siehe Error in den OpenAPI-Komponenten).

​
OpenAPI

Maschinenlesbare Spezifikation für Tools und Codegenerierung: /api-reference/openapi.json