Update product

Update a product (POST body is partial). Requires a Write key.

POST/products/{productId}

Authorization

AuthorizationBearer token (API key) · headerrequired

Organization API key.

Path parameters

productIdstringrequired

Request body

requiredapplication/json

namestring

pricenumber

Price in cents

taxCategorystring

Allowed:8.12.63.80

supplierstring

categorystring

declarationsstring

barcodestring

Normalized to lowercase; empty becomes the document id

externalIdstring

depositProductnumber

Deposit in cents

depositProductLabelstring

descriptionstring

salePricenumber

salePercentagenumber

salePriceDateFromstring<date-time>

salePriceDateTostring<date-time>

costPricenumber

marginnumber

showOnScreenboolean

ageRestrictionboolean

showOnScaleboolean

saleStopboolean

indexnumber

deletedboolean

Set true to soft-delete.

Responses

200Updated

successbooleanrequired

400Bad request

statusCodeintegerrequired

HTTP status code

messagestringrequired

Human-readable error message

timestampstring<date-time>required

pathstringrequired

Request path

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 POST "https://dashboard.scango.ch/api/v1/products/string" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "price": 0,
  "taxCategory": "8.1",
  "supplier": "string",
  "category": "string",
  "declarations": "string",
  "barcode": "string",
  "externalId": "string",
  "depositProduct": 0,
  "depositProductLabel": "string",
  "description": "string",
  "salePrice": 0,
  "salePercentage": 0,
  "salePriceDateFrom": "2024-01-01T00:00:00Z",
  "salePriceDateTo": "2024-01-01T00:00:00Z",
  "costPrice": 0,
  "margin": 0,
  "showOnScreen": true,
  "ageRestriction": true,
  "showOnScale": true,
  "saleStop": true,
  "index": 0,
  "deleted": true
}'

const response = await fetch("https://dashboard.scango.ch/api/v1/products/string", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "name": "string",
  "price": 0,
  "taxCategory": "8.1",
  "supplier": "string",
  "category": "string",
  "declarations": "string",
  "barcode": "string",
  "externalId": "string",
  "depositProduct": 0,
  "depositProductLabel": "string",
  "description": "string",
  "salePrice": 0,
  "salePercentage": 0,
  "salePriceDateFrom": "2024-01-01T00:00:00Z",
  "salePriceDateTo": "2024-01-01T00:00:00Z",
  "costPrice": 0,
  "margin": 0,
  "showOnScreen": true,
  "ageRestriction": true,
  "showOnScale": true,
  "saleStop": true,
  "index": 0,
  "deleted": true
})
});

Response

{
  "success": true
}