Lieferant anlegen

Lieferant anlegen. Erfordert einen Write-Key.

POST/suppliers

Autorisierung

AuthorizationBearer-Token (API-Key) · headererforderlich

Organisations-API-Key.

Request-Body

erforderlichapplication/json

namestringerforderlich

min length 1

externalIdstring

Optionale externe Kennung

companystring

citystring

streetstring

plzstring

emailstring

payoutEmailstring

orderEmailstring

phonestring

contactPersonstring

contactPhonestring

dailyMailstring

supplierMarginnumber

ibanstring

bicstring

bankNamestring

payoutsEnabledboolean

Antworten

200

Lieferant angelegt

successbooleanerforderlich

idstringerforderlich

400

Ungültige Parameter oder ungültiger Body.

statusCodeintegererforderlich

HTTP-Statuscode

messagestringerforderlich

Lesbare Fehlermeldung

timestampstring<date-time>erforderlich

Zeitpunkt des Fehlers (UTC).

pathstringerforderlich

Request-URL (Pfad und Query-String).

403

Fehlender, unbekannter oder inaktiver API-Key oder ein Read-Key bei einem Schreibzugriff.

statusCodeintegererforderlich

HTTP-Statuscode

messagestringerforderlich

Lesbare Fehlermeldung

timestampstring<date-time>erforderlich

Zeitpunkt des Fehlers (UTC).

pathstringerforderlich

Request-URL (Pfad und Query-String).

Ausprobieren

Server

Basis-URLEigene Basis-URLÜberschreibt den gewählten Server, wenn gesetzt.

Autorisierung

Bearer-Token (API-Key)Auf diesem Gerät merkenMeine Werte in Beispielen verwenden

Bodyapplication/json

namestring*externalIdstringOptionale externe KennungcompanystringcitystringstreetstringplzstringemailstringpayoutEmailstringorderEmailstringphonestringcontactPersonstringcontactPhonestringdailyMailstringsupplierMarginnumberibanstringbicstringbankNamestringpayoutsEnabledboolean

Anfrage

curl -X POST 'https://dashboard.scango.ch/api/v1/suppliers' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Beispiel AG",
  "company": "Beispiel AG",
  "city": "Zürich",
  "street": "Bahnhofstrasse 1",
  "plz": "8001",
  "email": "orders@example.ch"
}'

const response = await fetch("https://dashboard.scango.ch/api/v1/suppliers", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"Beispiel AG\",\n  \"company\": \"Beispiel AG\",\n  \"city\": \"Zürich\",\n  \"street\": \"Bahnhofstrasse 1\",\n  \"plz\": \"8001\",\n  \"email\": \"orders@example.ch\"\n}"
});

import requests

response = requests.post(
    "https://dashboard.scango.ch/api/v1/suppliers",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"Beispiel AG\",\n  \"company\": \"Beispiel AG\",\n  \"city\": \"Zürich\",\n  \"street\": \"Bahnhofstrasse 1\",\n  \"plz\": \"8001\",\n  \"email\": \"orders@example.ch\"\n}",
)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://dashboard.scango.ch/api/v1/suppliers',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer YOUR_TOKEN',
    'Accept: application/json',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => '{
  "name": "Beispiel AG",
  "company": "Beispiel AG",
  "city": "Zürich",
  "street": "Bahnhofstrasse 1",
  "plz": "8001",
  "email": "orders@example.ch"
}',
]);

$response = curl_exec($curl);

Antwort

{
  "success": true,
  "id": "newSupplierId"
}

{
  "statusCode": 400,
  "message": "Validation failed for Field: name, Error: Required",
  "timestamp": "2024-04-20T12:00:00.000Z",
  "path": "/api/v1/suppliers"
}

{
  "statusCode": 403,
  "message": "Unknown Error",
  "timestamp": "2024-04-20T12:00:00.000Z",
  "path": "/api/v1/products"
}