Elenca categorie

Elenca le categorie. Senza paginazione: restituisce fino a limit categorie attive, ordinate per name, senza nextCursor.

GET/categories

Autorizzazione

AuthorizationToken Bearer (chiave API) · headerobbligatorio

Chiave API dell'organizzazione.

Parametri query

limitinteger

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

min 1 · max 5000 · default: 100

Risposte

200

Categorie con meta

dataCategory[]obbligatorio

Mostra proprietà

Array di Category

idstringobbligatorio

namestring

externalIdstring

Identificativo esterno facoltativo

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 in data. Con includeDeleted=true (ordini) contano anche gli ordini eliminati.

limitintegerobbligatorio

Dimensione della pagina applicata.

offsetinteger

Solo per la ricerca prodotti con q.

nextCursorstring

Cursore opaco per la pagina successiva; passarlo invariato come cursor. Presente quando possono esistere altri risultati. Gli elementi eliminati (soft-delete) vengono filtrati dopo la lettura, quindi una pagina può essere più corta di limit anche con nextCursor presente. Mai restituito per categorie, fornitori e negozi, che non sono paginati.

400

Parametri query non validi.

errorValidationErrorobbligatorio

Dettagli di validazione.

Mostra proprietà

formErrorsstring[]obbligatorio

fieldErrorsobjectobbligatorio

403

Chiave API mancante, sconosciuta o inattiva, oppure chiave Read su un’operazione di scrittura.

statusCodeintegerobbligatorio

Codice di stato HTTP

messagestringobbligatorio

Messaggio di errore leggibile

timestampstring<date-time>obbligatorio

Momento dell’errore (UTC).

pathstringobbligatorio

URL della richiesta (percorso e query string).

Prova

Server

URL di baseURL di base personalizzatoSostituisce il server selezionato se impostato.

Autorizzazione

Token Bearer (chiave API)Ricorda su questo dispositivoUsa i miei valori negli esempi

Parametri

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

Richiesta

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

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

import requests

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

<?php

$curl = curl_init();

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

$response = curl_exec($curl);

Risposta

{
  "data": [
    {
      "id": "cat_01",
      "name": "Bevande",
      "index": 1,
      "showOnScreen": true
    }
  ],
  "meta": {
    "total": 1,
    "returned": 1,
    "limit": 100
  }
}

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