Lister les fournisseurs

Liste les fournisseurs.

GET/suppliers

Autorisation

AutorisationJeton Bearer (API key) · headerobligatoire

Clé API de l’organisation.

Paramètres de requête

limitinteger

Taille de page (1–5000, défaut 100).

min 1 · max 5000 · default: 100

Réponses

200Fournisseurs avec meta

dataSupplier[]obligatoire

Afficher les propriétés

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>

metaListMetaobligatoire

Métadonnées de liste. `returned` est la longueur de `data`. Les entrées de catalogue supprimées (soft delete) sont exclues des listes — `returned` peut être inférieur à `limit` même s'il reste des entrées actives.

Afficher les propriétés

totalintegerobligatoire

Avec recherche produit (`q`) : nombre estimé de correspondances. Sinon égal à `returned`. Peut être inférieur à `limit` lorsque des entrées supprimées ont été filtrées de la page.

returnedintegerobligatoire

Nombre d'éléments actifs dans `data` (entrées supprimées exclues).

limitintegerobligatoire

Taille de page appliquée.

offsetinteger

Uniquement pour la recherche produit avec `q`.

nextCursorstring

Curseur opaque pour la page suivante. Présent lorsque d'autres résultats sont possibles. Ne pas analyser ; transmettre tel quel comme `cursor`. Avec filtre soft-delete ou `store`, `returned < limit` ne signifie pas la fin de la liste.

400Requête incorrecte

errorValidationErrorobligatoire

Détails de validation.

Afficher les propriétés

formErrorsstring[]obligatoire

fieldErrorsobjectobligatoire

403Non autorisé

statusCodeintegerobligatoire

Code de statut HTTP

messagestringobligatoire

Message d’erreur lisible

timestampstring<date-time>obligatoire

pathstringobligatoire

Chemin de la requête

Requête

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: {
    "Autorisation": "Bearer YOUR_TOKEN"
  }
});

Réponse

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