Produkt per ID abrufen

Produkt anhand der ID abrufen. Ein soft-gelöschtes Produkt wird mit deleted: true zurückgegeben.

GET/products/{productId}

Autorisierung

AuthorizationBearer-Token (API-Key) · headererforderlich

Organisations-API-Key.

Pfadparameter

productIdstringerforderlich

Antworten

200

Produktdetails

dataProducterforderlich

Produkt. Geldfelder sind Ganzzahlen in Rappen.

Eigenschaften anzeigen

idstringerforderlich

Produkt-Dokument-ID

externalIdstring

Optionale externe Kennung

namestring

priceinteger

Preis in Rappen.

supplierstring

Lieferanten-ID

taxCategorystring

Schweizer MwSt.-Kategoriecode

Erlaubt:8.12.63.80

categorystring

Kategorie-ID

declarationsstring

barcodestring

barcodeAliasesobject[]

Optionale zusätzliche EANs. Fehlt, wenn nicht genutzt. Ein leeres Array wird nicht gespeichert. Verfügbar, wenn die Funktion Barcode-Aliase für die Organisation aktiviert ist.

Eigenschaften anzeigen

Array von object

codestringerforderlich

Zusätzliche EAN, wie barcode in Kleinbuchstaben

quantitynumber

Anzahl Basiseinheiten, für die dieser Code steht. Standard 1.

priceinteger

Optionaler Gebindepreis in Rappen

labelstring

externalIdstring

Optionale externe Artikel-ID

depositProductinteger

Depot in Rappen.

depositProductLabelstring

descriptionstring

salePriceinteger

Verkaufspreis in Rappen.

salePercentagenumber

salePriceDateFromstring<date-time>

salePriceDateTostring<date-time>

costPriceinteger

Einkaufspreis in Rappen.

marginnumber

showOnScreenboolean

ageRestrictionboolean

showOnScaleboolean

saleStopboolean

deactivatedboolean

openInputboolean

imageUrlstring

Bild-URL. Setzen via Produkt-Create/Update oder POST /products/{productId}/image. Leerer String beim Update löscht das Feld und org-eigene Storage-Objekte.

indexinteger

allowStorestring[]

Erlaubte Store-IDs (schreibgeschützt).

hideStorestring[]

Ausgeblendete Store-IDs (schreibgeschützt).

deletedboolean

Soft-gelöscht, wenn true.

createdatestring<date-time>

lastupdatestring<date-time>

instancestring

Organisations-ID, falls vorhanden

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*

Anfrage

curl -X GET 'https://dashboard.scango.ch/api/v1/products/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://dashboard.scango.ch/api/v1/products/string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://dashboard.scango.ch/api/v1/products/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://dashboard.scango.ch/api/v1/products/string',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer YOUR_TOKEN',
    'Accept: application/json',
  ],
]);

$response = curl_exec($curl);

Antwort

{
  "data": {
    "id": "a1b2c3",
    "name": "Mineralwasser 50cl",
    "price": 120,
    "barcode": "7610800001234",
    "taxCategory": "2.6",
    "category": "cat_01",
    "supplier": "sup_01",
    "description": "",
    "showOnScreen": true,
    "ageRestriction": false,
    "showOnScale": false,
    "saleStop": false,
    "imageUrl": ""
  }
}

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