Crea categoria

Crea una categoria. Richiede una chiave Write.

POST/categories

Autorizzazione

AuthorizationToken Bearer (chiave API) · headerobbligatorio

Chiave API dell'organizzazione.

Corpo della richiesta

obbligatorioapplication/json

namestringobbligatorio

min length 1

externalIdstring

Identificativo esterno facoltativo

indexnumber

showOnScreenboolean

imageUrlstring

marginMinPercentnumber

marginMaxPercentnumber

hideStorestring[]

Un array vuoto non viene salvato.

allowStorestring[]

Un array vuoto non viene salvato.

Risposte

200

Categoria creata

successbooleanobbligatorio

idstringobbligatorio

400

Parametri o body non validi.

statusCodeintegerobbligatorio

Codice di stato HTTP

messagestringobbligatorio

Messaggio di errore leggibile

timestampstring<date-time>obbligatorio

Momento dell’errore (UTC).

pathstringobbligatorio

URL della richiesta (percorso e query string).

403

Chiave API mancante, sconosciuta o inattiva, oppure chiave Read su un’operazione di scrittura.

statusCodeintegerobbligatorio

Codice di stato HTTP

messagestringobbligatorio

Messaggio di errore leggibile

timestampstring<date-time>obbligatorio

Momento dell’errore (UTC).

pathstringobbligatorio

URL della richiesta (percorso e query string).

Prova

Server

URL di baseURL di base personalizzatoSostituisce il server selezionato se impostato.

Autorizzazione

Token Bearer (chiave API)Ricorda su questo dispositivoUsa i miei valori negli esempi

Bodyapplication/json

Corpo della richiesta

Richiesta

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": "Bevande",
  "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\": \"Bevande\",\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\": \"Bevande\",\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": "Bevande",
  "index": 1,
  "showOnScreen": true
}',
]);

$response = curl_exec($curl);

Risposta

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