Create supplier

Create a supplier. Requires a Write key.

POST/suppliers

Authorization

AuthorizationBearer token (API key) · headerrequired

Organization API key.

Request body

requiredapplication/json

namestringrequired

min length 1

externalIdstring

Optional external identifier

companystring

citystring

streetstring

plzstring

emailstring

payoutEmailstring

orderEmailstring

phonestring

contactPersonstring

contactPhonestring

dailyMailstring

supplierMarginnumber

ibanstring

bicstring

bankNamestring

payoutsEnabledboolean

Responses

200

Supplier created

successbooleanrequired

idstringrequired

400

Invalid parameters or body.

statusCodeintegerrequired

HTTP status code

messagestringrequired

Human-readable error message

timestampstring<date-time>required

When the error occurred (UTC).

pathstringrequired

Request URL (path and query string).

403

Missing, unknown or inactive API key, or a Read key on a write operation.

statusCodeintegerrequired

HTTP status code

messagestringrequired

Human-readable error message

timestampstring<date-time>required

When the error occurred (UTC).

pathstringrequired

Request URL (path and query string).

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (API key)Remember on this deviceInclude my values in samples

Bodyapplication/json

namestring*externalIdstringOptional external identifiercompanystringcitystringstreetstringplzstringemailstringpayoutEmailstringorderEmailstringphonestringcontactPersonstringcontactPhonestringdailyMailstringsupplierMarginnumberibanstringbicstringbankNamestringpayoutsEnabledboolean

Request

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": "Example AG",
  "company": "Example 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\": \"Example AG\",\n  \"company\": \"Example 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\": \"Example AG\",\n  \"company\": \"Example 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": "Example AG",
  "company": "Example AG",
  "city": "Zürich",
  "street": "Bahnhofstrasse 1",
  "plz": "8001",
  "email": "orders@example.ch"
}',
]);

$response = curl_exec($curl);

Response

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