Mettre à jour une catégorie

Met à jour une catégorie (corps POST partiel). Nécessite une clé Write. Les tableaux allowStore ou hideStore vides suppriment le champ.

POST/categories/{categoryId}

Autorisation

AuthorizationJeton Bearer (clé API) · headerobligatoire

Clé API de l’organisation.

Paramètres de chemin

categoryIdstringobligatoire

Corps de la requête

obligatoireapplication/json

namestring

min length 1

externalIdstring

Identifiant externe facultatif

indexnumber

showOnScreenboolean

imageUrlstring

marginMinPercentnumber

marginMaxPercentnumber

hideStorestring[]

Un tableau vide supprime le champ.

allowStorestring[]

Un tableau vide supprime le champ.

deletedboolean

Mettre à true pour une suppression logique.

Réponses

200

Mis à jour

successbooleanobligatoire

400

Paramètres ou corps invalides.

statusCodeintegerobligatoire

Code de statut HTTP

messagestringobligatoire

Message d’erreur lisible

timestampstring<date-time>obligatoire

Moment de l’erreur (UTC).

pathstringobligatoire

URL de la requête (chemin et chaîne de requête).

403

Clé API absente, inconnue ou inactive, ou clé Read sur une opération d’écriture.

statusCodeintegerobligatoire

Code de statut HTTP

messagestringobligatoire

Message d’erreur lisible

timestampstring<date-time>obligatoire

Moment de l’erreur (UTC).

pathstringobligatoire

URL de la requête (chemin et chaîne de requête).

404

Aucun élément avec cet id.

statusCodeintegerobligatoire

Code de statut HTTP

messagestringobligatoire

Message d’erreur lisible

timestampstring<date-time>obligatoire

Moment de l’erreur (UTC).

pathstringobligatoire

URL de la requête (chemin et chaîne de requête).

Essayer

Serveur

URL de baseURL de base personnaliséeRemplace le serveur sélectionné si renseignée.

Autorisation

Jeton Bearer (clé API)Mémoriser sur cet appareilUtiliser mes valeurs dans les exemples

Paramètres

categoryIdpath*

Bodyapplication/json

Corps de la requête

Requête

curl -X POST 'https://dashboard.scango.ch/api/v1/categories/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "index": 2
}'

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

import requests

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

<?php

$curl = curl_init();

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

$response = curl_exec($curl);

Réponse

{
  "success": true
}

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

{
  "statusCode": 0,
  "message": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "path": "string"
}