Skip to content

English

DeutschNot translated English Français ItalianoNot translated

Create category

Create a category. Requires a Write key.

POST/categories

Authorization

AuthorizationBearer token (API key) · headerrequired

Organization API key.

Request body

requiredapplication/json

namestringrequired

indexnumber

showOnScreenboolean

imageUrlstring

marginMinPercentnumber

marginMaxPercentnumber

hideStorestring[]

allowStorestring[]

Responses

200Category 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/categories" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "index": 0,
  "showOnScreen": true,
  "imageUrl": "string",
  "marginMinPercent": 0,
  "marginMaxPercent": 0,
  "hideStore": [
    "string"
  ],
  "allowStore": [
    "string"
  ]
}'

const response = await fetch("https://dashboard.scango.ch/api/v1/categories", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "name": "string",
  "index": 0,
  "showOnScreen": true,
  "imageUrl": "string",
  "marginMinPercent": 0,
  "marginMaxPercent": 0,
  "hideStore": [
    "string"
  ],
  "allowStore": [
    "string"
  ]
})
});

Response

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