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

min length 1

externalIdstring

Optional external identifier

indexnumber

showOnScreenboolean

imageUrlstring

marginMinPercentnumber

marginMaxPercentnumber

hideStorestring[]

An empty array is not stored.

allowStorestring[]

An empty array is not stored.

Responses

200

Category 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/categories' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Beverages",
  "index": 1,
  "showOnScreen": true
}'

const response = await fetch("https://dashboard.scango.ch/api/v1/categories", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"Beverages\",\n  \"index\": 1,\n  \"showOnScreen\": true\n}"
});

import requests

response = requests.post(
    "https://dashboard.scango.ch/api/v1/categories",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"Beverages\",\n  \"index\": 1,\n  \"showOnScreen\": true\n}",
)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://dashboard.scango.ch/api/v1/categories',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer YOUR_TOKEN',
    'Accept: application/json',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => '{
  "name": "Beverages",
  "index": 1,
  "showOnScreen": true
}',
]);

$response = curl_exec($curl);

Response

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

{
  "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"
}