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

barcodeAliasesobject[]

Optional additional EANs. Empty array removes the field. Available when the barcode aliases feature is enabled for the organization.

Show properties

Array of object

codestringrequired

quantitynumber

priceinteger

Optional pack price in cents

labelstring

externalIdstring

Optional external article ID

externalIdstring

depositProductnumber

Deposit in cents

depositProductLabelstring

descriptionstring

salePricenumber | null

Sale price in cents. Null or empty string removes the field.

salePercentagenumber | null

Sale discount percentage. Null or empty string removes the field.

salePriceDateFromstring<date-time> | null

Sale start. Null or empty string removes the field.

salePriceDateTostring<date-time> | null

Sale end. Null or empty string removes the field.

costPricenumber

marginnumber

showOnScreenboolean

ageRestrictionboolean

showOnScaleboolean

saleStopboolean

deactivatedboolean

imageUrlstring

Image URL. Empty string clears the field and deletes the stored asset when it belongs to this organization (same as DELETE /products/{productId}/image).

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",
  "barcodeAliases": [
    {
      "code": "string",
      "quantity": 0,
      "price": 0,
      "label": "string",
      "externalId": "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,
  "imageUrl": "string",
  "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",
  "barcodeAliases": [
    {
      "code": "string",
      "quantity": 0,
      "price": 0,
      "label": "string",
      "externalId": "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,
  "imageUrl": "string",
  "index": 0,
  "deleted": true
})
});

Response

{
  "success": true
}