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

min length 1

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. Returns 403 Feature not available when barcode aliases are not 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, stored as given. To upload a file, use POST /products/{productId}/image.

indexnumber

Responses

200

Product created

successbooleanrequired

idstringrequired

400

Invalid parameters or body.

statusCodeintegerrequired

HTTP status code

messagestringrequired

Human-readable error message

timestampstring<date-time>required

When the error occurred (UTC).

pathstringrequired

Request URL (path and query string).

403

Missing, unknown or inactive API key, or a Read key on a write operation.

statusCodeintegerrequired

HTTP status code

messagestringrequired

Human-readable error message

timestampstring<date-time>required

When the error occurred (UTC).

pathstringrequired

Request URL (path and query string).

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (API key)Remember on this deviceInclude my values in samples

Bodyapplication/json

Request body

Request

curl -X POST 'https://dashboard.scango.ch/api/v1/products' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Orange juice 1L",
  "price": 349,
  "taxCategory": "2.6",
  "description": "Fresh orange juice",
  "supplier": "sup_01",
  "category": "cat_beverages",
  "barcode": "7610800009999",
  "externalId": "sku-oj-1l",
  "showOnScreen": true,
  "ageRestriction": false,
  "showOnScale": false,
  "saleStop": false
}'

const response = await fetch("https://dashboard.scango.ch/api/v1/products", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"Orange juice 1L\",\n  \"price\": 349,\n  \"taxCategory\": \"2.6\",\n  \"description\": \"Fresh orange juice\",\n  \"supplier\": \"sup_01\",\n  \"category\": \"cat_beverages\",\n  \"barcode\": \"7610800009999\",\n  \"externalId\": \"sku-oj-1l\",\n  \"showOnScreen\": true,\n  \"ageRestriction\": false,\n  \"showOnScale\": false,\n  \"saleStop\": false\n}"
});

import requests

response = requests.post(
    "https://dashboard.scango.ch/api/v1/products",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"Orange juice 1L\",\n  \"price\": 349,\n  \"taxCategory\": \"2.6\",\n  \"description\": \"Fresh orange juice\",\n  \"supplier\": \"sup_01\",\n  \"category\": \"cat_beverages\",\n  \"barcode\": \"7610800009999\",\n  \"externalId\": \"sku-oj-1l\",\n  \"showOnScreen\": true,\n  \"ageRestriction\": false,\n  \"showOnScale\": false,\n  \"saleStop\": false\n}",
)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://dashboard.scango.ch/api/v1/products',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer YOUR_TOKEN',
    'Accept: application/json',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => '{
  "name": "Orange juice 1L",
  "price": 349,
  "taxCategory": "2.6",
  "description": "Fresh orange juice",
  "supplier": "sup_01",
  "category": "cat_beverages",
  "barcode": "7610800009999",
  "externalId": "sku-oj-1l",
  "showOnScreen": true,
  "ageRestriction": false,
  "showOnScale": false,
  "saleStop": false
}',
]);

$response = curl_exec($curl);

Response

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

{
  "statusCode": 400,
  "message": "Validation failed for Field: name, Error: Required",
  "timestamp": "2024-04-20T12:00:00.000Z",
  "path": "/api/v1/suppliers"
}

{
  "statusCode": 403,
  "message": "Unknown Error",
  "timestamp": "2024-04-20T12:00:00.000Z",
  "path": "/api/v1/products"
}