scango.ch API

Kunden-REST-API für scango.ch.

Authentifizierung mit Authorization: Bearer <api-key> (Read- oder Write-Key). Geldbeträge sind Ganzzahlen in Rappen. Listen liefern { data, meta }.

Die API ist für Aufrufe von Server zu Server gedacht. Browser dürfen sie nur von dieser Dokumentation aus aufrufen (Ausprobieren). Request-Bodys sind JSON (max. 1 MB), sofern ein Endpunkt nichts anderes angibt. Datum-Zeit-Parameter müssen UTC im ISO-8601-Format mit Z sein (2024-01-01T00:00:00.000Z).

Fehler haben die Form { statusCode, message, timestamp, path }. Jeder Authentifizierungs- oder Berechtigungsfehler (fehlender, unbekannter oder inaktiver Key oder ein Read-Key bei einem Schreibzugriff) liefert 403. Eine nicht unterstützte HTTP-Methode liefert 405 mit Allow-Header.

Produkte

Produktkatalog

• GET
  Produkte auflisten oder suchen/products
• POST
  Produkt erstellen/products
• GET
  Produkt per ID abrufen/products/{productId}
• POST
  Produkt aktualisieren/products/{productId}
• DELETE
  Produkt löschen/products/{productId}
• POST
  Produktbild hochladen/products/{productId}/image
• DELETE
  Produktbild löschen/products/{productId}/image

Bestellungen

Bestellungen

• GET
  Bestellungen auflisten/orders
• GET
  Bestellung per ID abrufen/orders/{orderId}

Lieferanten

Lieferanten

• GET
  Lieferanten auflisten/suppliers
• POST
  Lieferant anlegen/suppliers
• GET
  Lieferant per ID abrufen/suppliers/{supplierId}
• POST
  Lieferant aktualisieren/suppliers/{supplierId}
• DELETE
  Lieferant löschen/suppliers/{supplierId}

Kategorien

Kategorien

• GET
  Kategorien auflisten/categories
• POST
  Kategorie anlegen/categories
• GET
  Kategorie per ID abrufen/categories/{categoryId}
• POST
  Kategorie aktualisieren/categories/{categoryId}
• DELETE
  Kategorie löschen/categories/{categoryId}

Filialen

Filialen

• GET
  Filialen auflisten/stores
• POST
  Filiale anlegen/stores
• GET
  Filiale per ID abrufen/stores/{storeId}
• POST
  Filiale aktualisieren/stores/{storeId}
• DELETE
  Filiale löschen/stores/{storeId}

Identitätsprotokolle

Identitätsprüfungsprotokolle und gesperrte Identitäten. Nur verfügbar, wenn die Identity-Logs-Funktion für die Organisation aktiviert ist.

• GET
  Identitätsprotokolle auflisten/identity-logs
• GET
  Identitätsprotokoll per ID abrufen/identity-logs/{logId}
• GET
  Gesperrte Identitäten auflisten/identity-logs/blocked
• POST
  Identität sperren/identity-logs/blocked
• POST
  Gesperrte Identität aktualisieren/identity-logs/blocked/{blockedId}
• DELETE
  Gesperrte Identität löschen/identity-logs/blocked/{blockedId}