Lister les fournisseurs

Liste les fournisseurs. Sans pagination : renvoie jusqu’à limit fournisseurs actifs, triés par name, sans nextCursor.

GET/suppliers

Autorisation

AuthorizationJeton Bearer (clé API) · 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

200

Fournisseurs avec meta

dataSupplier[]obligatoire

Afficher les propriétés

Tableau de Supplier

idstringobligatoire

namestring

externalIdstring

Identifiant externe facultatif

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 dans data. Avec includeDeleted=true (commandes), les commandes supprimées sont comptées.

limitintegerobligatoire

Taille de page appliquée.

offsetinteger

Uniquement pour la recherche produit avec q.

nextCursorstring

Curseur opaque pour la page suivante ; à transmettre tel quel dans cursor. Présent lorsque d’autres résultats peuvent exister. Les éléments supprimés logiquement sont filtrés après lecture, une page peut donc être plus courte que limit alors que nextCursor est présent. Jamais renvoyé pour les catégories, fournisseurs et magasins, qui ne sont pas paginés.

400

Paramètres de requête invalides.

errorValidationErrorobligatoire

Détails de validation.

Afficher les propriétés

formErrorsstring[]obligatoire

fieldErrorsobjectobligatoire

403

Clé API absente, inconnue ou inactive, ou clé Read sur une opération d’écriture.

statusCodeintegerobligatoire

Code de statut HTTP

messagestringobligatoire

Message d’erreur lisible

timestampstring<date-time>obligatoire

Moment de l’erreur (UTC).

pathstringobligatoire

URL de la requête (chemin et chaîne de requête).

Essayer

Serveur

URL de baseURL de base personnaliséeRemplace le serveur sélectionné si renseignée.

Autorisation

Jeton Bearer (clé API)Mémoriser sur cet appareilUtiliser mes valeurs dans les exemples

Paramètres

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

Requête

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

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

import requests

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

<?php

$curl = curl_init();

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

$response = curl_exec($curl);

Réponse

{
  "data": [
    {
      "id": "sup_01",
      "name": "Fournisseur exemple",
      "company": "Example AG",
      "city": "Zürich",
      "email": "orders@example.ch",
      "organizationId": "org_01"
    }
  ],
  "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"
}