Skip to content
scango.ch
English
DeutschNot translatedEnglishFrançaisNot translatedItalianoNot translated
Esc
↑↓navigate↵open⌘Jpreview

Get product by ID

Get a product by id.

GET/products/{productId}
Authorization
AuthorizationBearer token (API key) · headerrequired
Organization API key.
Path parameters
productIdstringrequired
Responses
200Product details
dataProductrequired
Product. Money fields are integer cents.
Show properties
idstring
Product document id
externalIdstring
Optional external identifier
namestring
priceinteger
Price in cents.
supplierstring
Supplier id
taxCategorystring
Swiss VAT category code
Allowed:8.12.63.80
categorystring
Category 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.
Show properties
Array of object
codestringrequired
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
Deposit in cents.
depositProductLabelstring
descriptionstring
salePriceinteger
Sale price in cents.
salePercentagenumber
salePriceDateFromstring<date-time>
salePriceDateTostring<date-time>
costPriceinteger
Cost price in cents.
marginnumber
showOnScreenboolean
ageRestrictionboolean
showOnScaleboolean
saleStopboolean
deactivatedboolean
openInputboolean
imageUrlstring
Image URL. Set via product create/update or POST /products/{productId}/image. Empty string on update clears the field and deletes org-owned storage.
indexinteger
allowStorestring[]
Allowed store ids (read-only).
hideStorestring[]
Hidden store ids (read-only).
deletedboolean
Soft-deleted when true.
createdatestring<date-time>
lastupdatestring<date-time>
instancestring
Organization id when present
403Unauthorized
statusCodeintegerrequired
HTTP status code
messagestringrequired
Human-readable error message
timestampstring<date-time>required
pathstringrequired
Request path
404Not found
statusCodeintegerrequired
HTTP status code
messagestringrequired
Human-readable error message
timestampstring<date-time>required
pathstringrequired
Request path
Request
curl -X GET "https://dashboard.scango.ch/api/v1/products/string" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "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"
  }
}