List stores

List store locations. Use city as the human-readable label alongside name.

GET/stores

Authorization

AuthorizationBearer token (API key) · headerrequired

Organization API key.

Query parameters

limitinteger

Page size (1–5000, default 100).

min 1 · max 5000 · default: 100

Responses

200Stores with meta

dataStore[]required

Show properties

Array of Store

idstring

namestring

citystring

Human-readable store label within the organization

addressstring

zipCodestring

vatNumberstring

paymentCashboolean

paymentPaytecboolean

paymentZahlsboolean

paymentZahlsOfflineboolean

paymentCashOfflineboolean

showSupplierboolean

logoUrlstring

languageMainstring

Allowed:deenfrit

deletedboolean

metaListMetarequired

List metadata. `returned` is the length of `data`. Soft-deleted catalog rows are omitted from list results, so `returned` may be less than `limit` even when more active items exist. When `nextCursor` is present, more pages may exist — keep paging until `nextCursor` is absent.

Show properties

totalintegerrequired

With product search (`q`) without `store`: estimated match count. With `store`: equals `returned` after store visibility filtering. Otherwise equals `returned`. Soft-deleted items are omitted, so a page may be shorter than `limit` even when more active items exist.

returnedintegerrequired

Number of active items in `data` (soft-deleted rows excluded).

limitintegerrequired

Applied page size.

offsetinteger

Only for product search with `q`.

nextCursorstring

Opaque cursor for the next page. Present when more results may exist. Do not parse; pass unchanged as `cursor`. Under soft-delete filtering, `returned < limit` does not mean the list is finished.

400Bad request

errorValidationErrorrequired

Validation details.

Show properties

formErrorsstring[]required

fieldErrorsobjectrequired

403Unauthorized

statusCodeintegerrequired

HTTP status code

messagestringrequired

Human-readable error message

timestampstring<date-time>required

pathstringrequired

Request path

Request

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: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

Response

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