Produkte auflisten oder suchen

Produkte auflisten oder mit q suchen.

Ohne q sind Produkte nach name sortiert; mit cursor paginieren. Mit q sind Treffer nach Relevanz sortiert und werden mit offset paginiert; limit ist auf 250 begrenzt. Sieht q wie ein Barcode aus (mindestens 8 Buchstaben, Ziffern, - oder _, davon mindestens eine Ziffer), wird barcode bzw. barcodeAliases exakt verglichen statt Text gesucht.

Suchtreffer enthalten nur einen Teil der Felder: id, name, price, barcode, supplier, category, externalId, taxCategory, margin, imageUrl, allowStore, hideStore, die Aktionsfelder, deactivated, ageRestriction, showOnScreen, openInput und showOnScale. Den vollständigen Datensatz liefert der Abruf per ID.

GET/products

Autorisierung

AuthorizationBearer-Token (API-Key) · headererforderlich

Organisations-API-Key.

Query-Parameter

qstring

Suchtext. Schaltet auf Suche um: Paginierung mit offset, limit höchstens 250.

limitinteger

Seitengrösse (1–5000, Standard 100). Mit q werden Werte über 250 auf 250 reduziert; meta.limit zeigt den angewendeten Wert.

min 1 · max 5000 · default: 100

offsetinteger

Anzahl zu überspringender Suchtreffer. Nur mit q, sonst ignoriert.

min 0 · max 10000 · default: 0

storestring

Nur Produkte, die in dieser Filiale sichtbar sind (Filial-ID). Funktioniert mit und ohne q. Mit q zählt meta.total dann die gefilterte Seite statt alle Treffer zu schätzen.

min length 1

cursorstring

meta.nextCursor der vorherigen Seite. Nur ohne q (beides zusammen liefert 400). Nicht parsen; ein unbekannter Cursor beginnt wieder bei der ersten Seite.

min length 1

Antworten

200

Produktliste mit Meta.

dataProduct[]erforderlich

Eigenschaften anzeigen

Array von Product

idstringerforderlich

Produkt-Dokument-ID

externalIdstring

Optionale externe Kennung

namestring

priceinteger

Preis in Rappen.

supplierstring

Lieferanten-ID

taxCategorystring

Schweizer MwSt.-Kategoriecode

Erlaubt:8.12.63.80

categorystring

Kategorie-ID

declarationsstring

barcodestring

barcodeAliasesobject[]

Optionale zusätzliche EANs. Fehlt, wenn nicht genutzt. Ein leeres Array wird nicht gespeichert. Verfügbar, wenn die Funktion Barcode-Aliase für die Organisation aktiviert ist.

Eigenschaften anzeigen

Array von object

codestringerforderlich

Zusätzliche EAN, wie barcode in Kleinbuchstaben

quantitynumber

Anzahl Basiseinheiten, für die dieser Code steht. Standard 1.

priceinteger

Optionaler Gebindepreis in Rappen

labelstring

externalIdstring

Optionale externe Artikel-ID

depositProductinteger

Depot in Rappen.

depositProductLabelstring

descriptionstring

salePriceinteger

Verkaufspreis in Rappen.

salePercentagenumber

salePriceDateFromstring<date-time>

salePriceDateTostring<date-time>

costPriceinteger

Einkaufspreis in Rappen.

marginnumber

showOnScreenboolean

ageRestrictionboolean

showOnScaleboolean

saleStopboolean

deactivatedboolean

openInputboolean

imageUrlstring

Bild-URL. Setzen via Produkt-Create/Update oder POST /products/{productId}/image. Leerer String beim Update löscht das Feld und org-eigene Storage-Objekte.

indexinteger

allowStorestring[]

Erlaubte Store-IDs (schreibgeschützt).

hideStorestring[]

Ausgeblendete Store-IDs (schreibgeschützt).

deletedboolean

Soft-gelöscht, wenn true.

createdatestring<date-time>

lastupdatestring<date-time>

instancestring

Organisations-ID, falls vorhanden

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).

503

Die Produktsuche ist vorübergehend nicht verfügbar.

errorstringerforderlich

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

qquerySuchtext. Schaltet auf Suche um: Paginierung mit `offset`, `limit` höchstens 250.limitquerySeitengrösse (1–5000, Standard 100). Mit `q` werden Werte über 250 auf 250 reduziert; `meta.limit` zeigt den angewendeten Wert.offsetqueryAnzahl zu überspringender Suchtreffer. Nur mit `q`, sonst ignoriert.storequeryNur Produkte, die in dieser Filiale sichtbar sind (Filial-ID). Funktioniert mit und ohne `q`. Mit `q` zählt `meta.total` dann die gefilterte Seite statt alle Treffer zu schätzen.cursorquery`meta.nextCursor` der vorherigen Seite. Nur ohne `q` (beides zusammen liefert 400). Nicht parsen; ein unbekannter Cursor beginnt wieder bei der ersten Seite.

Anfrage

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

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

import requests

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

<?php

$curl = curl_init();

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

$response = curl_exec($curl);

Antwort

{
  "data": [
    {
      "id": "a1b2c3",
      "name": "Mineralwasser 50cl",
      "price": 120,
      "barcode": "7610800001234",
      "taxCategory": "2.6",
      "category": "cat_01",
      "supplier": "sup_01",
      "showOnScreen": true
    }
  ],
  "meta": {
    "total": 1,
    "returned": 1,
    "limit": 1,
    "nextCursor": "a1b2c3"
  }
}

{
  "data": [
    {
      "id": "a1b2c3",
      "name": "Mineralwasser 50cl",
      "price": 120,
      "barcode": "7610800001234",
      "taxCategory": "2.6"
    }
  ],
  "meta": {
    "total": 42,
    "returned": 20,
    "limit": 20,
    "offset": 0
  }
}

{
  "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"
}

{
  "error": "Product search failed"
}