Filialen auflisten

Filialstandorte auflisten. city ist das lesbare Label neben name.

GET/stores

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

200Filialen mit Meta

dataStore[]erforderlich

Eigenschaften anzeigen

Array of Store

idstring

namestring

citystring

Human-readable store label within the organization

addressstring

zipCodestring

vatNumberstring

paymentCashboolean

paymentPaytecboolean

paymentZahlsboolean

paymentZahlsOfflineboolean

paymentCashOfflineboolean

showSupplierboolean

logoUrlstring

languageMainstring

Erlaubt:deenfrit

deletedboolean

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/stores" \
  -H "Authorization: Bearer YOUR_TOKEN"

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

Antwort

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "city": "string",
      "address": "string",
      "zipCode": "string",
      "vatNumber": "string",
      "paymentCash": true,
      "paymentPaytec": true,
      "paymentZahls": true,
      "paymentZahlsOffline": true,
      "paymentCashOffline": true,
      "showSupplier": true,
      "logoUrl": "string",
      "languageMain": "de",
      "deleted": true
    }
  ],
  "meta": {
    "total": 0,
    "returned": 0,
    "limit": 0,
    "offset": 0,
    "nextCursor": "string"
  }
}