Mettre à jour un produit

Met à jour un produit (corps POST partiel). Nécessite une clé Write.

POST/products/{productId}

Autorisation

AuthorizationJeton Bearer (clé API) · headerobligatoire

Clé API de l’organisation.

Paramètres de chemin

productIdstringobligatoire

Corps de la requête

obligatoireapplication/json

namestring

min length 1

pricenumber

Prix en centimes

taxCategorystring

Autorisé:8.12.63.80

supplierstring

categorystring

declarationsstring

barcodestring

Normalisé en minuscules.

barcodeAliasesobject[]

EAN supplémentaires facultatifs. Un tableau vide supprime le champ. Disponible lorsque la fonction alias de code-barres est activée pour l’organisation ; sinon 403 Feature not available.

Afficher les propriétés

Tableau de object

codestringobligatoire

quantitynumber

priceinteger

Prix facultatif du lot en centimes

labelstring

externalIdstring

Id d’article externe facultatif

externalIdstring

depositProductnumber

Consigne en centimes

depositProductLabelstring

descriptionstring

salePricenumber | null

Prix promo en centimes. Null ou chaîne vide supprime le champ.

salePercentagenumber | null

Remise promo en pourcentage. Null ou chaîne vide supprime le champ.

salePriceDateFromstring<date-time> | null

Début de la promo. Null ou chaîne vide supprime le champ.

salePriceDateTostring<date-time> | null

Fin de la promo. Null ou chaîne vide supprime le champ.

costPricenumber

marginnumber

showOnScreenboolean

ageRestrictionboolean

showOnScaleboolean

saleStopboolean

deactivatedboolean

imageUrlstring

URL de l’image. La remplacer ou la vider (chaîne vide) supprime le fichier image précédent s’il est stocké par cette organisation.

indexnumber

deletedboolean

true supprime logiquement le produit, false le restaure.

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

productIdpath*

Bodyapplication/json

Corps de la requête

Requête

curl -X POST 'https://dashboard.scango.ch/api/v1/products/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "price": 129,
  "saleStop": false
}'

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

import requests

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

<?php

$curl = curl_init();

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

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