Vai al contenuto
scango.ch
Italiano
DeutschNon tradottoEnglishNon tradottoFrançaisNon tradottoItaliano
Esc
↑↓naviga↵apri⌘Janteprima

Elenca o cerca prodotti

Elenca i prodotti oppure cerca con q. La ricerca supporta offset e limita la dimensione della pagina a 250. Senza q, paginare con cursor e limit.

GET/products
Autorizzazione
AutorizzazioneToken Bearer (API key) · headerobbligatorio
Chiave API dell'organizzazione.
Parametri query
qstring
Testo di ricerca. Abilita la paginazione con `offset`.
limitinteger
Dimensione della pagina (1–5000, predefinito 100; max 250 con `q`).
min 1 · max 5000 · default: 100
offsetinteger
Salta i risultati della ricerca. Solo con `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
Id documento opaco per la pagina successiva. Solo senza `q` (funziona con `store`). Non analizzare. Seguire `meta.nextCursor` finché assente. Con `store` o soft-delete, `returned` può essere minore di `limit` mentre `nextCursor` è ancora presente.
Risposte
200Elenco di prodotti con meta.
dataProduct[]obbligatorio
Mostra proprietà
Array of Product
idstring
Id del documento prodotto
externalIdstring
Identificatore esterno opzionale
namestring
priceinteger
Prezzo in centesimi.
supplierstring
Id del fornitore
taxCategorystring
Codice categoria IVA svizzera
Consentiti:8.12.63.80
categorystring
Id della categoria
declarationsstring
barcodestring
barcodeAliasesobject[]
Optional additional EANs. Absent when unused. Empty array is not persisted. Available when the barcode aliases feature is enabled for the organization.
Mostra proprietà
Array of object
codestringobbligatorio
Additional EAN, lowercased like barcode
quantitynumber
Base units represented by this code. Defaults to 1.
priceinteger
Optional pack price in cents
labelstring
externalIdstring
Optional external article ID
depositProductinteger
Cauzione in centesimi.
depositProductLabelstring
descriptionstring
salePriceinteger
Prezzo di vendita in centesimi.
salePercentagenumber
salePriceDateFromstring<date-time>
salePriceDateTostring<date-time>
costPriceinteger
Prezzo di costo in centesimi.
marginnumber
showOnScreenboolean
ageRestrictionboolean
showOnScaleboolean
saleStopboolean
deactivatedboolean
openInputboolean
imageUrlstring
URL dell'immagine. Impostare via create/update prodotto o POST /products/{productId}/image. Stringa vuota in update cancella il campo e gli oggetti storage dell'organizzazione.
indexinteger
allowStorestring[]
Id dei negozi consentiti (sola lettura).
hideStorestring[]
Id dei negozi nascosti (sola lettura).
deletedboolean
Soft-delete quando true.
createdatestring<date-time>
lastupdatestring<date-time>
instancestring
Id dell'organizzazione se presente
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
503Ricerca non disponibile
errorstringobbligatorio
Richiesta
curl -X GET "https://dashboard.scango.ch/api/v1/products" \
  -H "Authorization: Bearer YOUR_TOKEN"
Risposta
{
  "data": [
    {
      "id": "string",
      "externalId": "string",
      "name": "string",
      "price": 0,
      "supplier": "string",
      "taxCategory": "8.1",
      "category": "string",
      "declarations": "string",
      "barcode": "string",
      "barcodeAliases": [
        {
          "code": "string",
          "quantity": 0,
          "price": 0,
          "label": "string",
          "externalId": "string"
        }
      ],
      "depositProduct": 0,
      "depositProductLabel": "string",
      "description": "string",
      "salePrice": 0,
      "salePercentage": 0,
      "salePriceDateFrom": "2019-08-24T14:15:22Z",
      "salePriceDateTo": "2019-08-24T14:15:22Z",
      "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": "2019-08-24T14:15:22Z",
      "lastupdate": "2019-08-24T14:15:22Z",
      "instance": "string"
    }
  ],
  "meta": {
    "total": 0,
    "returned": 0,
    "limit": 0,
    "offset": 0,
    "nextCursor": "string"
  }
}