Kategorien auflisten

Kategorien auflisten.

GET/categories

Autorisierung

AutorisierungBearer-Token (API key) · headererforderlich

Organisations-API-Key.

Query-Parameter

limitinteger

Seitengrösse (1–5000, Standard 100).

min 1 · max 5000 · default: 100

Antworten

200Kategorien mit Meta

dataCategory[]erforderlich

Eigenschaften anzeigen

Array of Category

idstring

namestring

indexinteger

showOnScreenboolean

imageUrlstring

marginMinPercentnumber

marginMaxPercentnumber

deletedboolean

hideStorestring[]

allowStorestring[]

createdatestring<date-time>

metaListMetaerforderlich

Listen-Metadaten. `returned` ist die Länge von `data`. Soft-gelöschte Katalogeinträge fehlen in Listen — `returned` kann kleiner als `limit` sein, auch wenn noch aktive Einträge existieren.

Eigenschaften anzeigen

totalintegererforderlich

Bei Produktsuche (`q`): geschätzte Trefferanzahl. Sonst gleich `returned`. Kann kleiner als `limit` sein, wenn soft-gelöschte Einträge von der Seite gefiltert wurden.

returnedintegererforderlich

Anzahl aktiver Einträge in `data` (soft-gelöschte ausgeschlossen).

limitintegererforderlich

Angewendete Seitengrösse.

offsetinteger

Nur bei Produktsuche mit `q`.

nextCursorstring

Opaker Cursor für die nächste Seite. Gesetzt, wenn weitere Ergebnisse möglich sind. Unverändert als `cursor` übergeben. Bei Soft-Delete- oder `store`-Filter bedeutet `returned < limit` nicht, dass die Liste zu Ende ist.

400Ungültige Anfrage

errorValidationErrorerforderlich

Validierungsdetails.

Eigenschaften anzeigen

formErrorsstring[]erforderlich

fieldErrorsobjecterforderlich

403Nicht autorisiert

statusCodeintegererforderlich

HTTP-Statuscode

messagestringerforderlich

Lesbare Fehlermeldung

timestampstring<date-time>erforderlich

pathstringerforderlich

Request-Pfad

Anfrage

curl -X GET "https://dashboard.scango.ch/api/v1/categories" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://dashboard.scango.ch/api/v1/categories", {
  method: "GET",
  headers: {
    "Autorisierung": "Bearer YOUR_TOKEN"
  }
});

Antwort

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "index": 0,
      "showOnScreen": true,
      "imageUrl": "string",
      "marginMinPercent": 0,
      "marginMaxPercent": 0,
      "deleted": true,
      "hideStore": [
        "string"
      ],
      "allowStore": [
        "string"
      ],
      "createdate": "2024-01-01T00:00:00Z"
    }
  ],
  "meta": {
    "total": 0,
    "returned": 0,
    "limit": 0,
    "offset": 0,
    "nextCursor": "string"
  }
}