Elenca fornitori

Elenca i fornitori.

GET/suppliers

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

200Fornitori con meta

dataSupplier[]obbligatorio

Mostra proprietà

Array of Supplier

idstring

namestring

externalIdstring

Optional external identifier

companystring

citystring

streetstring

plzstring

organizationIdstring

emailstring

payoutEmailstring

orderEmailstring

phonestring

contactPersonstring

contactPhonestring

dailyMailstring

deletedboolean

supplierMarginnumber

ibanstring

bicstring

bankNamestring

payoutsEnabledboolean

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/suppliers" \
  -H "Authorization: Bearer YOUR_TOKEN"

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

Risposta

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "externalId": "string",
      "company": "string",
      "city": "string",
      "street": "string",
      "plz": "string",
      "organizationId": "string",
      "email": "string",
      "payoutEmail": "string",
      "orderEmail": "string",
      "phone": "string",
      "contactPerson": "string",
      "contactPhone": "string",
      "dailyMail": "string",
      "deleted": true,
      "supplierMargin": 0,
      "iban": "string",
      "bic": "string",
      "bankName": "string",
      "payoutsEnabled": true,
      "createdate": "2019-08-24T14:15:22Z"
    }
  ],
  "meta": {
    "total": 0,
    "returned": 0,
    "limit": 0,
    "offset": 0,
    "nextCursor": "string"
  }
}