Créer un produit

Crée un produit. Nécessite une clé Write.

POST/products

Autorisation

AuthorizationJeton Bearer (clé API) · headerobligatoire

Clé API de l’organisation.

Corps de la requête

obligatoireapplication/json

namestringobligatoire

min length 1

pricenumberobligatoire

Prix en centimes

taxCategorystringobligatoire

Autorisé:8.12.63.80

supplierstring

categorystring

declarationsstring

barcodestring

Normalisé en minuscules ; vide devient l’id du document

barcodeAliasesobject[]

EAN supplémentaires facultatifs. À omettre s’ils ne sont pas utilisés. 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

salePercentagenumber

salePriceDateFromstring<date-time>

salePriceDateTostring<date-time>

costPricenumber

marginnumber

showOnScreenboolean

ageRestrictionboolean

showOnScaleboolean

saleStopboolean

deactivatedboolean

imageUrlstring

URL de l’image, enregistrée telle quelle. Pour téléverser un fichier, utilisez POST /products/{productId}/image.

indexnumber

Réponses

200

Produit créé

successbooleanobligatoire

idstringobligatoire

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).

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

Bodyapplication/json

Corps de la requête

Requête

curl -X POST 'https://dashboard.scango.ch/api/v1/products' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Jus d’orange 1L",
  "price": 349,
  "taxCategory": "2.6",
  "description": "Jus d’orange frais",
  "supplier": "sup_01",
  "category": "cat_beverages",
  "barcode": "7610800009999",
  "externalId": "sku-oj-1l",
  "showOnScreen": true,
  "ageRestriction": false,
  "showOnScale": false,
  "saleStop": false
}'

const response = await fetch("https://dashboard.scango.ch/api/v1/products", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"Jus d’orange 1L\",\n  \"price\": 349,\n  \"taxCategory\": \"2.6\",\n  \"description\": \"Jus d’orange frais\",\n  \"supplier\": \"sup_01\",\n  \"category\": \"cat_beverages\",\n  \"barcode\": \"7610800009999\",\n  \"externalId\": \"sku-oj-1l\",\n  \"showOnScreen\": true,\n  \"ageRestriction\": false,\n  \"showOnScale\": false,\n  \"saleStop\": false\n}"
});

import requests

response = requests.post(
    "https://dashboard.scango.ch/api/v1/products",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"Jus d’orange 1L\",\n  \"price\": 349,\n  \"taxCategory\": \"2.6\",\n  \"description\": \"Jus d’orange frais\",\n  \"supplier\": \"sup_01\",\n  \"category\": \"cat_beverages\",\n  \"barcode\": \"7610800009999\",\n  \"externalId\": \"sku-oj-1l\",\n  \"showOnScreen\": true,\n  \"ageRestriction\": false,\n  \"showOnScale\": false,\n  \"saleStop\": false\n}",
)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://dashboard.scango.ch/api/v1/products',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer YOUR_TOKEN',
    'Accept: application/json',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => '{
  "name": "Jus d’orange 1L",
  "price": 349,
  "taxCategory": "2.6",
  "description": "Jus d’orange frais",
  "supplier": "sup_01",
  "category": "cat_beverages",
  "barcode": "7610800009999",
  "externalId": "sku-oj-1l",
  "showOnScreen": true,
  "ageRestriction": false,
  "showOnScale": false,
  "saleStop": false
}',
]);

$response = curl_exec($curl);

Réponse

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

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