Zum Inhalt springen
scango.ch
Deutsch
DeutschEnglishNicht übersetztFrançaisNicht übersetztItalianoNicht übersetzt
Esc
↑↓navigieren↵öffnen⌘JVorschau

Produkt per ID abrufen

Produkt anhand der ID abrufen.

GET/products/{productId}
Autorisierung
AutorisierungBearer-Token (API key) · headererforderlich
Organisations-API-Key.
Pfadparameter
productIdstringerforderlich
Antworten
200Produktdetails
dataProducterforderlich
Produkt. Geldfelder sind Ganzzahlen in Rappen.
Eigenschaften anzeigen
idstring
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[]
Optional additional EANs. Absent when unused. Empty array is not persisted. Available when the barcode aliases feature is enabled for the organization.
Eigenschaften anzeigen
Array of object
codestringerforderlich
Additional EAN, lowercased like barcode
quantitynumber
Base units represented by this code. Defaults to 1.
priceinteger
Optional pack price in cents
labelstring
externalIdstring
Optional external article 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
403Nicht autorisiert
statusCodeintegererforderlich
HTTP-Statuscode
messagestringerforderlich
Lesbare Fehlermeldung
timestampstring<date-time>erforderlich
pathstringerforderlich
Request-Pfad
404Not found
statusCodeintegererforderlich
HTTP-Statuscode
messagestringerforderlich
Lesbare Fehlermeldung
timestampstring<date-time>erforderlich
pathstringerforderlich
Request-Pfad
Anfrage
curl -X GET "https://dashboard.scango.ch/api/v1/products/string" \
  -H "Authorization: Bearer YOUR_TOKEN"
Antwort
{
  "data": {
    "id": "string",
    "externalId": "string",
    "name": "string",
    "price": 0,
    "supplier": "string",
    "taxCategory": "8.1",
    "category": "string",
    "declarations": "string",
    "barcode": "string",
    "barcodeAliases": [
      {
        "code": "string",
        "quantity": 0,
        "price": 0,
        "label": "string",
        "externalId": "string"
      }
    ],
    "depositProduct": 0,
    "depositProductLabel": "string",
    "description": "string",
    "salePrice": 0,
    "salePercentage": 0,
    "salePriceDateFrom": "2019-08-24T14:15:22Z",
    "salePriceDateTo": "2019-08-24T14:15:22Z",
    "costPrice": 0,
    "margin": 0,
    "showOnScreen": true,
    "ageRestriction": true,
    "showOnScale": true,
    "saleStop": true,
    "deactivated": true,
    "openInput": true,
    "imageUrl": "string",
    "index": 0,
    "allowStore": [
      "string"
    ],
    "hideStore": [
      "string"
    ],
    "deleted": true,
    "createdate": "2019-08-24T14:15:22Z",
    "lastupdate": "2019-08-24T14:15:22Z",
    "instance": "string"
  }
}