Skip to content

English

DeutschNot translated English FrançaisNot translated ItalianoNot translated

Create product

Create a product. Requires a Write key.

POST/products

Authorization

AuthorizationBearer token (API key) · headerrequired

Organization API key.

Request body

requiredapplication/json

namestringrequired

pricenumberrequired

Price in cents

taxCategorystringrequired

Allowed:8.12.63.80

supplierstring

categorystring

declarationsstring

barcodestring

Normalized to lowercase; empty becomes the document id

barcodeAliasesobject[]

Optional additional EANs. Omit when unused. 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

salePercentagenumber

salePriceDateFromstring<date-time>

salePriceDateTostring<date-time>

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

Responses

200Product created

successbooleanrequired

idstringrequired

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

Request

curl -X POST "https://dashboard.scango.ch/api/v1/products" \
  -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
}'

const response = await fetch("https://dashboard.scango.ch/api/v1/products", {
  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
})
});

Response

{
  "success": true,
  "id": "string"
}