Zum Hauptinhalt springen
GET
/
products
List or search products
curl --request GET \
  --url https://dashboard.scango.ch/api/v1/products \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "a1b2c3",
      "name": "Mineral water 50cl",
      "price": 120,
      "barcode": "7610800001234",
      "taxCategory": "2.6",
      "category": "cat_01",
      "supplier": "sup_01"
    }
  ],
  "meta": {
    "total": 1,
    "returned": 1,
    "limit": 100
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.scango.ch/llms.txt

Use this file to discover all available pages before exploring further.

Ohne Abfrageparameter q liefert der Endpunkt Produkte aus der Datenbank bis zur angegebenen limit (1–5000, Standard 100). Mit q und einem nicht leeren Suchbegriff erfolgt eine Volltextsuche (z. B. über Name und Barcode); derselbe limit gilt, die Suche begrenzt die effektive Seitengröße jedoch auf 250 (siehe meta.limit). offset (0–10 000, Standard 0) nur mit q für Paginierung. store nur bei Suche mit q; er begrenzt Treffer auf Produkte, die für diesen Laden freigegeben sind. Antworten enthalten meta (total, returned, limit, bei Verwendung von q außerdem offset). Siehe Einführung.

Autorisierungen

​
Authorization
string
header
erforderlich

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Abfrageparameter

​
q
string

Search text. If omitted or empty, all products are returned.

​
limit
integer
Standard:100

Maximum number of products in this response. Must be between 1 and 5000. Default is 100. Applies with or without q; when using q, search caps the effective value at 250.

Erforderlicher Bereich: 1 <= x <= 5000
​
offset
integer
Standard:0

When using q, number of search hits to skip (pagination). Must be between 0 and 10000. Default is 0.

Erforderlicher Bereich: 0 <= x <= 10000
​
store
string

When using q, only include products allowed for this store ID.

Antwort

List of products. When q is used, results come from search and field set may differ slightly from the non-search response. The response always includes meta with limit (and offset when searching); see ListMeta.

​
data
object[]
erforderlich
​
meta
object
erforderlich

Included on every list response. returned is the length of data. For Firestore-backed lists (/products without q, /orders, /suppliers, /categories), total equals returned for that response (the API does not return a separate full match count). For product search with q, total is the search index’s estimated number of matching documents. limit is the applied page size (query default 100, maximum 5000; search with q caps the effective page size at 250). offset is only used for product search with q.