Produkte auflisten oder suchen

Produkte auflisten oder mit q suchen. Die Suche unterstützt offset und begrenzt die Seitengrösse auf 250. Ohne q gilt nur limit.

GET/products

Autorisierung

AutorisierungBearer-Token (API key) · headererforderlich

Organisations-API-Key.

Query-Parameter

qstring

Suchtext. Aktiviert `offset`-Pagination.

limitinteger

Seitengrösse (1–5000, Standard 100; max. 250 mit `q`).

min 1 · max 5000 · default: 100

offsetinteger

Suchtreffer überspringen. Nur mit `q`.

min 0 · max 10000 · default: 0

storestring

Filter by store id. Works with and without `q`. When set, `meta.total` reflects the filtered page (not the unfiltered search estimate).

cursorstring

Opake Dokument-ID für die nächste Seite. Nur ohne `q` (auch mit `store`). Nicht parsen. `meta.nextCursor` folgen, bis es fehlt. Mit `store` oder Soft-Delete kann `returned < limit` sein, während `nextCursor` gesetzt ist.

Antworten

200Produktliste mit Meta.

dataProduct[]erforderlich

Eigenschaften anzeigen

Array of Product

idstring

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

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 (schreibgeschützt).

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

503Suche nicht verfügbar

errorstringerforderlich

Anfrage

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

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

Antwort

{
  "data": [
    {
      "id": "string",
      "externalId": "string",
      "name": "string",
      "price": 0,
      "supplier": "string",
      "taxCategory": "8.1",
      "category": "string",
      "declarations": "string",
      "barcode": "string",
      "depositProduct": 0,
      "depositProductLabel": "string",
      "description": "string",
      "salePrice": 0,
      "salePercentage": 0,
      "salePriceDateFrom": "2024-01-01T00:00:00Z",
      "salePriceDateTo": "2024-01-01T00:00:00Z",
      "costPrice": 0,
      "margin": 0,
      "showOnScreen": true,
      "ageRestriction": true,
      "showOnScale": true,
      "saleStop": true,
      "deactivated": true,
      "openInput": true,
      "imageUrl": "string",
      "index": 0,
      "allowStore": [
        "string"
      ],
      "hideStore": [
        "string"
      ],
      "deleted": true,
      "createdate": "2024-01-01T00:00:00Z",
      "lastupdate": "2024-01-01T00:00:00Z",
      "instance": "string"
    }
  ],
  "meta": {
    "total": 0,
    "returned": 0,
    "limit": 0,
    "offset": 0,
    "nextCursor": "string"
  }
}