Playground API

Testa l'endpoint di aggiornamento prodotto con i tuoi dati.

Autenticazione Richiesta

Devi essere loggato per utilizzare il Playground API. Accedi per continuare.

Endpoint Aggiornamento Prodotto

Aggiorna le informazioni del prodotto nel tuo inventario

POST

L'endpoint di aggiornamento consente di modificare le informazioni di un prodotto specifico nel tuo inventario. È possibile identificare il prodotto tramite codice EAN, ASIN, GTIN, MINSAN o SKU.

È possibile aggiornare vari campi del prodotto inclusi nome, descrizioni, caratteristiche chiave, metadati SEO e assegnazioni di categoria.

URL dell'Endpoint
POST https://api.commerceclarity.io/api/v1/products/update

Corpo della Richiesta

Parametro Tipo Obbligatorio Descrizione
code string Obbligatorio Identificatore del prodotto. Può essere un codice EAN, ASIN, GTIN, MINSAN o SKU
country string Obbligatorio Codice paese ISO (2 caratteri) per la versione specifica del mercato
name string Opzionale Nome prodotto (massimo 255 caratteri)
short_description string Opzionale Breve descrizione del prodotto (massimo 500 caratteri)
description string Opzionale Descrizione dettagliata del prodotto (20-10.000 caratteri)
key_features array Opzionale Array delle caratteristiche chiave del prodotto (ciascuna massimo 255 caratteri)
category_id string Opzionale Identificatore categoria. Può essere l'ID categoria personalizzato assegnato da te o l'ID assegnato da CommerceClarity alla categoria
title_tag string Opzionale Tag title SEO (massimo 255 caratteri)
meta_description string Opzionale Meta description SEO (massimo 320 caratteri)
meta_keywords string Opzionale Meta keywords SEO come stringa separata da virgole (massimo 1.000 caratteri)
pictures array Opzionale Array di URL immagini (ciascuno massimo 500 caratteri)
customer_code string Opzionale Codice cliente personalizzato per il prodotto
product_handle string Opzionale Handle del prodotto per generazione URL e identificazione
grouped_specifications array Opzionale Specifiche del prodotto organizzate per gruppi e categorie
required_specifications array Opzionale Specifiche essenziali e obbligatorie del prodotto
custom_sections array Opzionale Sezioni di contenuto personalizzate definite dall'utente
global_fields array Opzionale Campi globali del prodotto applicabili a tutti i mercati
category_fields array Opzionale Campi specifici della categoria del prodotto

Stati di Risposta

Codice Status Descrizione
200 success Prodotto aggiornato con successo
404 error Prodotto non trovato con l'identificatore fornito
422 error Validazione della richiesta fallita
500 error Errore interno del server durante l'aggiornamento

Esempi di Risposta

Risposta di Successo
{
  "message": "Product updated successfully"
}
Risposta Errore di Validazione
{
  "status": "error",
  "errors": [
    "The product code is required.",
    "The country code is required."
  ]
}
Risposta di Errore - Validazione
{
  "message": "Product not found in the database"
}
Risposta Errore Server
{
  "message": "Failed to update product",
  "error": "Internal server error details"
}

Esempi di Codice

Esempio PHP (Utilizzo del Client HTTP Guzzle)
<?php
require 'vendor/autoload.php';

use GuzzleHttp\Client;
use GuzzleHttp\Exception\RequestException;

$client = new Client([
    'base_uri' => 'https://api.commerceclarity.io',
    'timeout'  => 10.0,
    'headers' => [
        'Authorization' => 'Bearer IL_TUO_TOKEN_API',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ]
]);

$productCode = '8004120057724'; // Codice prodotto da eliminare
$country = 'it'; // Codice paese

$updateData = [
    'product_code' => $productCode,
    'country' => $country,
    'name' => 'Crema Viso Organica Premium',
    'short_description' => 'Crema idratante organica nutriente per tutti i tipi di pelle',
    'description' => 'Questa crema viso organica premium è formulata con ingredienti naturali per fornire idratazione profonda e nutrimento per tutti i tipi di pelle. Arricchita con aloe vera, vitamina E e oli essenziali.',
    'key_features' => [
        'Ingredienti 100% organici',
        'Adatta a tutti i tipi di pelle',
        'Testata dermatologicamente'
    ],
    'title_tag' => 'Crema Viso Organica Premium | Cura Naturale della Pelle',
    'meta_description' => 'Scopri la nostra crema viso organica premium con ingredienti naturali. Perfetta per tutti i tipi di pelle, fornisce idratazione profonda e nutrimento.',
    'meta_keywords' => 'crema organica, cura naturale pelle, crema viso, idratazione, vitamina E'
];

try {
    $response = $client->post('/api/v1/products/update', [
        'json' => $updateData
    ]);
    
    $result = json_decode($response->getBody()->getContents(), true);
    
    if (isset($result['message'])) {
        echo "Aggiornamento riuscito: " . $result['message'] . "\n";
    } else {
        echo "Aggiornamento prodotto completato con successo\n";
    }
    
} catch (RequestException $e) {
    echo "Errore: " . $e->getMessage() . "\n";
    
    if ($e->hasResponse()) {
        $errorResponse = json_decode($e->getResponse()->getBody()->getContents(), true);
        echo "Codice errore: " . $e->getResponse()->getStatusCode() . "\n";
        
        if (isset($errorResponse['errors'])) {
            echo "Errori di validazione:\n";
            foreach ($errorResponse['errors'] as $error) {
                echo "- " . $error . "\n";
            }
        } else {
            echo "Messaggio: " . ($errorResponse['message'] ?? 'nessun messaggio') . "\n";
        }
    }
}
?>
Esempio JavaScript (Fetch API)
const productCode = '8004120057724'; // Codice prodotto da eliminare
const country = 'it'; // Codice paese
const apiUrl = 'https://api.commerceclarity.io/api/v1/products/update';
const token = 'IL_TUO_TOKEN_API';

const updateData = {
  product_code: productCode,
  country: country,
  name: 'Crema Viso Organica Premium',
  short_description: 'Crema idratante organica nutriente per tutti i tipi di pelle',
  description: 'Questa crema viso organica premium è formulata con ingredienti naturali per fornire idratazione profonda e nutrimento per tutti i tipi di pelle. Arricchita con aloe vera, vitamina E e oli essenziali.',
  key_features: [
    'Ingredienti 100% organici',
    'Adatta a tutti i tipi di pelle',
    'Testata dermatologicamente'
  ],
  title_tag: 'Crema Viso Organica Premium | Cura Naturale della Pelle',
  meta_description: 'Scopri la nostra crema viso organica premium con ingredienti naturali. Perfetta per tutti i tipi di pelle, fornisce idratazione profonda e nutrimento.',
  meta_keywords: 'crema organica, cura naturale pelle, crema viso, idratazione, vitamina E'
};

// Effettua la richiesta di aggiornamento API
fetch(apiUrl, {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Accept': 'application/json',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(updateData)
})
.then(response => {
  if (!response.ok) {
    return response.json().then(errorData => {
      throw new Error(errorData.message || `Status: ${response.status}`);
    });
  }
  return response.json();
})
.then(data => {
  if (data.message) {
    console.log(`Aggiornamento riuscito: ${data.message}`);
  } else {
    console.log('Aggiornamento prodotto completato con successo');
  }
})
.catch(error => {
  console.error('Errore nell'aggiornamento del prodotto:', error.message);
});
Esempio Python (Requests)
import requests
import json

# Configurazione API
product_code = '8004120057724'  # Codice prodotto da eliminare
country = 'it'  # Codice paese
api_url = 'https://api.commerceclarity.io/api/v1/products/update'
token = 'IL_TUO_TOKEN_API'

headers = {
    'Authorization': f'Bearer {token}',
    'Accept': 'application/json',
    'Content-Type': 'application/json'
}

update_data = {
    'product_code': product_code,
    'country': country,
    'name': 'Crema Viso Organica Premium',
    'short_description': 'Crema idratante organica nutriente per tutti i tipi di pelle',
    'description': 'Questa crema viso organica premium è formulata con ingredienti naturali per fornire idratazione profonda e nutrimento per tutti i tipi di pelle. Arricchita con aloe vera, vitamina E e oli essenziali.',
    'key_features': [
        'Ingredienti 100% organici',
        'Adatta a tutti i tipi di pelle',
        'Testata dermatologicamente'
    ],
    'title_tag': 'Crema Viso Organica Premium | Cura Naturale della Pelle',
    'meta_description': 'Scopri la nostra crema viso organica premium con ingredienti naturali. Perfetta per tutti i tipi di pelle, fornisce idratazione profonda e nutrimento.',
    'meta_keywords': 'crema organica, cura naturale pelle, crema viso, idratazione, vitamina E'
}

try:
    # Effettua la richiesta di aggiornamento
    response = requests.post(api_url, headers=headers, json=update_data)
    
    # Solleva eccezione per errori HTTP
    response.raise_for_status()
    
    # Estrai i dati dalla risposta
    result = response.json()
    
    if 'message' in result:
        print(f"Stato di pubblicazione aggiornato con successo per: {result['message']}")
    else:
        print('Aggiornamento prodotto completato con successo')
        
except requests.exceptions.HTTPError as err:
    print(f"Errore HTTP: {err}")
    if response.text:
        try:
            error_data = response.json()
            if 'errors' in error_data:
                print("Errori di validazione:")
                for error in error_data['errors']:
                    print(f"- {error}")
            else:
                print(f"Messaggio di errore: {error_data.get('message', 'nessun messaggio')}")
        except json.JSONDecodeError:
            print(f"Testo di risposta: {response.text}")
        
except requests.exceptions.RequestException as err:
    print(f"Errore durante la richiesta: {err}")
Esempio cURL
curl -X POST "https://api.commerceclarity.io/api/v1/products/update" \
  -H "Authorization: Bearer IL_TUO_TOKEN_API" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "product_code": "8004120057724",
    "country": "it",
    "name": "Crema Viso Organica Premium",
    "short_description": "Crema idratante organica nutriente per tutti i tipi di pelle",
    "description": "Questa crema viso organica premium è formulata con ingredienti naturali.",
    "key_features": [
      "Ingredienti 100% organici",
      "Adatta a tutti i tipi di pelle",
      "Testata dermatologicamente"
    ],
    "title_tag": "Crema Viso Organica Premium | Cura Naturale della Pelle",
    "meta_description": "Scopri la nostra crema viso organica premium con ingredienti naturali.",
    "meta_keywords": "crema organica, cura naturale pelle, crema viso"
  }'

Risorse Correlate

Dettagli Prodotto

Verifica lo stato attuale di un prodotto specifico nel tuo inventario.

Vai a Dettagli Prodotto
Eliminazione Prodotti

Impara come rimuovere permanentemente prodotti dal tuo inventario.

Vai all'Eliminazione Prodotti