Produkt aktualisieren

Produkt aktualisieren (POST-Body ist partiell). Erfordert einen Write-Key.

POST/products/{productId}

Autorisierung

AuthorizationBearer-Token (API-Key) · headererforderlich

Organisations-API-Key.

Pfadparameter

productIdstringerforderlich

Request-Body

erforderlichapplication/json

namestring

min length 1

pricenumber

Preis in Rappen

taxCategorystring

Erlaubt:8.12.63.80

supplierstring

categorystring

declarationsstring

barcodestring

Wird in Kleinbuchstaben gespeichert.

barcodeAliasesobject[]

Optionale zusätzliche EANs. Ein leeres Array entfernt das Feld. Verfügbar, wenn die Funktion Barcode-Aliase für die Organisation aktiviert ist; sonst 403 Feature not available.

Eigenschaften anzeigen

Array von object

codestringerforderlich

quantitynumber

priceinteger

Optionaler Gebindepreis in Rappen

labelstring

externalIdstring

Optionale externe Artikel-ID

externalIdstring

depositProductnumber

Depot in Rappen

depositProductLabelstring

descriptionstring

salePricenumber | null

Aktionspreis in Rappen. Null oder leerer String entfernt das Feld.

salePercentagenumber | null

Aktionsrabatt in Prozent. Null oder leerer String entfernt das Feld.

salePriceDateFromstring<date-time> | null

Aktionsbeginn. Null oder leerer String entfernt das Feld.

salePriceDateTostring<date-time> | null

Aktionsende. Null oder leerer String entfernt das Feld.

costPricenumber

marginnumber

showOnScreenboolean

ageRestrictionboolean

showOnScaleboolean

saleStopboolean

deactivatedboolean

imageUrlstring

Bild-URL. Ersetzen oder Leeren (leerer String) löscht die bisherige Bilddatei, wenn sie von dieser Organisation gespeichert ist.

indexnumber

deletedboolean

true löscht das Produkt soft, false stellt es wieder her.

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

productIdpath*

Bodyapplication/json

Request-Body

Anfrage

curl -X POST 'https://dashboard.scango.ch/api/v1/products/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "price": 129,
  "saleStop": false
}'

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

import requests

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

<?php

$curl = curl_init();

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

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