Filiale aktualisieren

Filiale aktualisieren (POST-Body ist partiell). Erfordert einen Write-Schlüssel. null löscht optionale Felder. Zahlungsanbieter-Zugangsdaten (Zahls) bleiben Dashboard-only.

POST/stores/{storeId}

Autorisierung

AuthorizationBearer-Token (API-Key) · headererforderlich

Organisations-API-Key.

Pfadparameter

storeIdstringerforderlich

Request-Body

erforderlichapplication/json

namestring

min length 1

addressstring | null

zipCodestring | null

citystring | null

Lesbares Filial-Label innerhalb der Organisation

vatNumberstring | null

paymentCashboolean | null

paymentPaytecboolean | null

paymentZahlsboolean | null

paymentZahlsOfflineboolean | null

paymentCashOfflineboolean | null

showSupplierboolean | null

hideTextStartboolean | null

generalMarginnumber | null

customMessagestring | null

backgroundImageCartstring | object | null

null entfernt das Feld.

Eigenschaften anzeigen

Eines von:

string

string

object

srcstring

backgroundImagestring | object | null

null entfernt das Feld.

Eigenschaften anzeigen

Eines von:

string

string

object

srcstring

backgroundColorstring | null

backgroundFontColorstring | null

playSoundboolean | null

standardSoundstring | null

adminMailstring | null

showInfoButtonboolean | null

showPicturesboolean | null

showPicturesScaleboolean | null

deleteCountdownnumber | null

logoUrlstring | null

languageMultiboolean | null

languageMainstring | null

Erlaubt:deenfrit

languageSelectorstring[] | null

translationsobject | null

deletedboolean

Auf true setzen zum Soft-Löschen.

Antworten

200

Aktualisiert

successbooleanerforderlich

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

404

Kein Eintrag mit dieser ID.

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

Parameter

storeIdpath*

Bodyapplication/json

Request-Body

Anfrage

curl -X POST 'https://dashboard.scango.ch/api/v1/stores/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/stores/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/stores/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/stores/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);

Antwort

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