Produkt erstellen

Produkt erstellen. Erfordert einen Write-Key.

POST/products

Autorisierung

AuthorizationBearer-Token (API-Key) · headererforderlich

Organisations-API-Key.

Request-Body

erforderlichapplication/json

namestringerforderlich

min length 1

pricenumbererforderlich

Preis in Rappen

taxCategorystringerforderlich

Erlaubt:8.12.63.80

supplierstring

categorystring

declarationsstring

barcodestring

Normalisiert zu Kleinbuchstaben; leer wird zur Dokument-ID

barcodeAliasesobject[]

Optionale zusätzliche EANs. Weglassen, wenn nicht genutzt. 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

salePercentagenumber

salePriceDateFromstring<date-time>

salePriceDateTostring<date-time>

costPricenumber

marginnumber

showOnScreenboolean

ageRestrictionboolean

showOnScaleboolean

saleStopboolean

deactivatedboolean

imageUrlstring

Bild-URL, wird unverändert gespeichert. Für einen Datei-Upload POST /products/{productId}/image verwenden.

indexnumber

Antworten

200

Produkt erstellt

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

Request-Body

Anfrage

curl -X POST 'https://dashboard.scango.ch/api/v1/products' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Orangensaft 1L",
  "price": 349,
  "taxCategory": "2.6",
  "description": "Frischer Orangensaft",
  "supplier": "sup_01",
  "category": "cat_beverages",
  "barcode": "7610800009999",
  "externalId": "sku-oj-1l",
  "showOnScreen": true,
  "ageRestriction": false,
  "showOnScale": false,
  "saleStop": false
}'

const response = await fetch("https://dashboard.scango.ch/api/v1/products", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"Orangensaft 1L\",\n  \"price\": 349,\n  \"taxCategory\": \"2.6\",\n  \"description\": \"Frischer Orangensaft\",\n  \"supplier\": \"sup_01\",\n  \"category\": \"cat_beverages\",\n  \"barcode\": \"7610800009999\",\n  \"externalId\": \"sku-oj-1l\",\n  \"showOnScreen\": true,\n  \"ageRestriction\": false,\n  \"showOnScale\": false,\n  \"saleStop\": false\n}"
});

import requests

response = requests.post(
    "https://dashboard.scango.ch/api/v1/products",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"Orangensaft 1L\",\n  \"price\": 349,\n  \"taxCategory\": \"2.6\",\n  \"description\": \"Frischer Orangensaft\",\n  \"supplier\": \"sup_01\",\n  \"category\": \"cat_beverages\",\n  \"barcode\": \"7610800009999\",\n  \"externalId\": \"sku-oj-1l\",\n  \"showOnScreen\": true,\n  \"ageRestriction\": false,\n  \"showOnScale\": false,\n  \"saleStop\": false\n}",
)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://dashboard.scango.ch/api/v1/products',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer YOUR_TOKEN',
    'Accept: application/json',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => '{
  "name": "Orangensaft 1L",
  "price": 349,
  "taxCategory": "2.6",
  "description": "Frischer Orangensaft",
  "supplier": "sup_01",
  "category": "cat_beverages",
  "barcode": "7610800009999",
  "externalId": "sku-oj-1l",
  "showOnScreen": true,
  "ageRestriction": false,
  "showOnScale": false,
  "saleStop": false
}',
]);

$response = curl_exec($curl);

Antwort

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

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