Update supplier

Update a supplier (POST body is partial). Requires a Write key.

POST/suppliers/{supplierId}

Authorization

AuthorizationBearer token (API key) · headerrequired

Organization API key.

Path parameters

supplierIdstringrequired

Request body

requiredapplication/json

namestring

min length 1

externalIdstring

Optional external identifier

companystring

citystring

streetstring

plzstring

emailstring

payoutEmailstring

orderEmailstring

phonestring

contactPersonstring

contactPhonestring

dailyMailstring

supplierMarginnumber

ibanstring

bicstring

bankNamestring

payoutsEnabledboolean

deletedboolean

Set true to soft-delete.

Responses

200

Updated

successbooleanrequired

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).

404

No item with this id.

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

Parameters

supplierIdpath*

Bodyapplication/json

namestringexternalIdstringOptional external identifiercompanystringcitystringstreetstringplzstringemailstringpayoutEmailstringorderEmailstringphonestringcontactPersonstringcontactPhonestringdailyMailstringsupplierMarginnumberibanstringbicstringbankNamestringpayoutsEnabledbooleandeletedbooleanSet true to soft-delete.

Request

curl -X POST 'https://dashboard.scango.ch/api/v1/suppliers/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "city": "Bern"
}'

const response = await fetch("https://dashboard.scango.ch/api/v1/suppliers/string", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"city\": \"Bern\"\n}"
});

import requests

response = requests.post(
    "https://dashboard.scango.ch/api/v1/suppliers/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"city\": \"Bern\"\n}",
)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://dashboard.scango.ch/api/v1/suppliers/string',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer YOUR_TOKEN',
    'Accept: application/json',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => '{
  "city": "Bern"
}',
]);

$response = curl_exec($curl);

Response

{
  "success": true
}

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

{
  "statusCode": 0,
  "message": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "path": "string"
}