Elenca o cerca prodotti

Elenca i prodotti o li cerca con q.

Senza q, i prodotti sono ordinati per name; paginare con cursor. Con q, i risultati sono ordinati per pertinenza e paginati con offset; limit è limitato a 250. Se q sembra un codice a barre (almeno 8 lettere, cifre, - o _, di cui almeno una cifra), viene confrontato esattamente con barcode e barcodeAliases invece di cercare nel testo.

I risultati di ricerca contengono solo una parte dei campi: id, name, price, barcode, supplier, category, externalId, taxCategory, margin, imageUrl, allowStore, hideStore, i campi promozione, deactivated, ageRestriction, showOnScreen, openInput e showOnScale. Per il record completo, ottieni il prodotto per id.

GET/products

Autorizzazione

AuthorizationToken Bearer (chiave API) · headerobbligatorio

Chiave API dell'organizzazione.

Parametri query

qstring

Testo di ricerca. Attiva la ricerca: paginazione con offset, limit al massimo 250.

limitinteger

Dimensione della pagina (1–5000, predefinito 100). Con q, i valori oltre 250 vengono ridotti a 250; meta.limit mostra il valore applicato.

min 1 · max 5000 · default: 100

offsetinteger

Numero di risultati da saltare. Solo con q, altrimenti ignorato.

min 0 · max 10000 · default: 0

storestring

Solo i prodotti visibili in questo negozio (id del negozio). Funziona con e senza q. Con q, meta.total conta allora la pagina filtrata invece di stimare tutti i risultati.

min length 1

cursorstring

meta.nextCursor della pagina precedente. Solo senza q (entrambi insieme restituiscono 400). Non analizzarlo; un cursore sconosciuto riparte dalla prima pagina.

min length 1

Risposte

200

Elenco di prodotti con meta.

dataProduct[]obbligatorio

Mostra proprietà

Array di Product

idstringobbligatorio

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[]

EAN aggiuntivi facoltativi. Assente se non usato. Un array vuoto non viene salvato. Disponibile se la funzione alias dei codici a barre è attiva per l’organizzazione.

Mostra proprietà

Array di object

codestringobbligatorio

EAN aggiuntivo, in minuscolo come barcode

quantitynumber

Unità di base rappresentate da questo codice. Predefinito 1.

priceinteger

Prezzo facoltativo della confezione in centesimi

labelstring

externalIdstring

Id articolo esterno facoltativo

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 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).

503

La ricerca prodotti è temporaneamente non disponibile.

errorstringobbligatorio

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

qqueryTesto di ricerca. Attiva la ricerca: paginazione con `offset`, `limit` al massimo 250.limitqueryDimensione della pagina (1–5000, predefinito 100). Con `q`, i valori oltre 250 vengono ridotti a 250; `meta.limit` mostra il valore applicato.offsetqueryNumero di risultati da saltare. Solo con `q`, altrimenti ignorato.storequerySolo i prodotti visibili in questo negozio (id del negozio). Funziona con e senza `q`. Con `q`, `meta.total` conta allora la pagina filtrata invece di stimare tutti i risultati.cursorquery`meta.nextCursor` della pagina precedente. Solo senza `q` (entrambi insieme restituiscono 400). Non analizzarlo; un cursore sconosciuto riparte dalla prima pagina.

Richiesta

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

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

import requests

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

<?php

$curl = curl_init();

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

$response = curl_exec($curl);

Risposta

{
  "data": [
    {
      "id": "a1b2c3",
      "name": "Acqua minerale 50cl",
      "price": 120,
      "barcode": "7610800001234",
      "taxCategory": "2.6",
      "category": "cat_01",
      "supplier": "sup_01",
      "showOnScreen": true
    }
  ],
  "meta": {
    "total": 1,
    "returned": 1,
    "limit": 1,
    "nextCursor": "a1b2c3"
  }
}

{
  "data": [
    {
      "id": "a1b2c3",
      "name": "Acqua minerale 50cl",
      "price": 120,
      "barcode": "7610800001234",
      "taxCategory": "2.6"
    }
  ],
  "meta": {
    "total": 42,
    "returned": 20,
    "limit": 20,
    "offset": 0
  }
}

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

{
  "error": "Product search failed"
}