Filialen auflisten

Filialstandorte auflisten. city ist das lesbare Label neben name. Ohne Paginierung: liefert bis zu limit aktive Filialen, sortiert nach ID, ohne nextCursor.

GET/stores

Autorisierung

AuthorizationBearer-Token (API-Key) · headererforderlich

Organisations-API-Key.

Query-Parameter

limitinteger

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

min 1 · max 5000 · default: 100

Antworten

200

Filialen mit Meta

dataStore[]erforderlich

Eigenschaften anzeigen

Array von Store

idstringerforderlich

namestring

citystring

Lesbare Bezeichnung der Filiale innerhalb der Organisation

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 Einträge in data. Mit includeDeleted=true (Bestellungen) zählen gelöschte Bestellungen mit.

limitintegererforderlich

Angewendete Seitengrösse.

offsetinteger

Nur bei Produktsuche mit q.

nextCursorstring

Opaker Cursor für die nächste Seite; unverändert als cursor übergeben. Vorhanden, wenn weitere Ergebnisse existieren können. Soft-gelöschte Einträge werden nach dem Lesen herausgefiltert, daher kann eine Seite kürzer als limit sein, obwohl nextCursor gesetzt ist. Bei Kategorien, Lieferanten und Filialen nie vorhanden, da diese nicht paginiert sind.

400

Ungültige Query-Parameter.

errorValidationErrorerforderlich

Validierungsdetails.

Eigenschaften anzeigen

formErrorsstring[]erforderlich

fieldErrorsobjecterforderlich

403

Fehlender, unbekannter oder inaktiver API-Key oder ein Read-Key bei einem Schreibzugriff.

statusCodeintegererforderlich

HTTP-Statuscode

messagestringerforderlich

Lesbare Fehlermeldung

timestampstring<date-time>erforderlich

Zeitpunkt des Fehlers (UTC).

pathstringerforderlich

Request-URL (Pfad und Query-String).

Ausprobieren

Server

Basis-URLEigene Basis-URLÜberschreibt den gewählten Server, wenn gesetzt.

Autorisierung

Bearer-Token (API-Key)Auf diesem Gerät merkenMeine Werte in Beispielen verwenden

Parameter

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

Anfrage

curl -X GET 'https://dashboard.scango.ch/api/v1/stores' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

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

import requests

response = requests.get(
    "https://dashboard.scango.ch/api/v1/stores",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://dashboard.scango.ch/api/v1/stores',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer YOUR_TOKEN',
    'Accept: application/json',
  ],
]);

$response = curl_exec($curl);

Antwort

{
  "data": [
    {
      "id": "store_01",
      "name": "Hauptfiliale",
      "city": "Zürich",
      "address": "Bahnhofstrasse 1",
      "zipCode": "8001"
    }
  ],
  "meta": {
    "total": 1,
    "returned": 1,
    "limit": 100
  }
}

{
  "error": {
    "formErrors": [],
    "fieldErrors": {
      "limit": [
        "Number must be less than or equal to 5000"
      ]
    }
  }
}

{
  "statusCode": 403,
  "message": "Unknown Error",
  "timestamp": "2024-04-20T12:00:00.000Z",
  "path": "/api/v1/products"
}