Elenca categorie

Elenca le categorie.

GET/categories

Autorizzazione

AutorizzazioneToken Bearer (API key) · headerobbligatorio

Chiave API dell'organizzazione.

Parametri query

limitinteger

Dimensione della pagina (1–5000, predefinito 100).

min 1 · max 5000 · default: 100

Risposte

200Categorie con meta

dataCategory[]obbligatorio

Mostra proprietà

Array of Category

idstring

namestring

indexinteger

showOnScreenboolean

imageUrlstring

marginMinPercentnumber

marginMaxPercentnumber

deletedboolean

hideStorestring[]

allowStorestring[]

createdatestring<date-time>

metaListMetaobbligatorio

Metadati dell'elenco. `returned` è la lunghezza di `data`. Le voci di catalogo eliminate (soft delete) sono escluse dagli elenchi — `returned` può essere minore di `limit` anche se esistono altre voci attive.

Mostra proprietà

totalintegerobbligatorio

Con ricerca prodotti (`q`): conteggio stimato dei risultati. Altrimenti uguale a `returned`. Può essere minore di `limit` quando voci eliminate sono state filtrate dalla pagina.

returnedintegerobbligatorio

Numero di elementi attivi in `data` (righe eliminate escluse).

limitintegerobbligatorio

Dimensione della pagina applicata.

offsetinteger

Solo per la ricerca prodotti con `q`.

nextCursorstring

Cursore opaco per la pagina successiva. Presente quando possono esistere altri risultati. Non analizzare; passare invariato come `cursor`. Con filtro soft-delete o `store`, `returned < limit` non significa fine elenco.

400Richiesta non valida

errorValidationErrorobbligatorio

Dettagli di validazione.

Mostra proprietà

formErrorsstring[]obbligatorio

fieldErrorsobjectobbligatorio

403Non autorizzato

statusCodeintegerobbligatorio

Codice di stato HTTP

messagestringobbligatorio

Messaggio di errore leggibile

timestampstring<date-time>obbligatorio

pathstringobbligatorio

Percorso della richiesta

Richiesta

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

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

Risposta

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "index": 0,
      "showOnScreen": true,
      "imageUrl": "string",
      "marginMinPercent": 0,
      "marginMaxPercent": 0,
      "deleted": true,
      "hideStore": [
        "string"
      ],
      "allowStore": [
        "string"
      ],
      "createdate": "2024-01-01T00:00:00Z"
    }
  ],
  "meta": {
    "total": 0,
    "returned": 0,
    "limit": 0,
    "offset": 0,
    "nextCursor": "string"
  }
}