Le API di commercioVirtuoso.it ti permettono di aggiungere nuovi prodotti al tuo negozio in modo programmatico. In questa guida, ti mostreremo come utilizzare l’endpoint /api/v2/products.json per creare un nuovo prodotto.
Documentazione API e Sandbox
Puoi visualizzare la lista completa degli Endpoint API e una Sandbox per simulare le chiamate e le risposte direttamente accedendo a: https://api.commerciovirtuoso.it
Creare un Prodotto
Per creare un nuovo prodotto, dovrai effettuare una richiesta POST all’endpoint /api/v2/products.json con i dettagli del prodotto nel corpo della richiesta. Di seguito sono riportati i passaggi dettagliati su come farlo.
Endpoint
POST /api/v2/products.json
Parametri della Richiesta
La richiesta deve contenere un oggetto JSON con tutti i dettagli necessari del prodotto. Ecco un esempio di corpo della richiesta:
Corpo della Richiesta
{
"seller_id": "101",
"type": "1",
"product_name": "Test Product",
"product_type": "Test",
"product_description": "product description",
"variants": [
{
"sku": "H101",
"barcode": "101",
"weight": "10",
"dimension": "{\"length\":\"1\", \"width\":\"1\", \"height\":\"1\", \"girth\":\"1\"}",
"price": "100.00",
"compare_at_price": "150.00",
"charge_taxes": 0,
"require_shipping": "1",
"track_inventory": "1",
"quantity": "10",
"inventory_policy": "0"
}
],
"options": [
{
"name": "Title",
"values": "New"
}
],
"images": [
{
"image_url": "https://example.com/example.png",
"image_alt": "test-image",
"position": "0",
"image_attachment": "string"
}
]
}
Descrizione dei Campi
Qui puoi descrivere il valore di ciascun campo nel corpo della richiesta:
- seller_id: ID del venditore
- type: Tipo di prodotto (impostare sempre a 1)
- product_name: Nome del prodotto
- product_type: Categoria del prodotto
- product_description: Descrizione del prodotto.
- variants: Varianti del prodotto, inclusi campi come SKU, barcode, peso, dimensioni, prezzo, ecc.
- sku: Codice SKU della variante.
- barcode: Codice a barre della variante.
- weight: Peso della variante.
- dimension: Dimensioni della variante in formato JSON.
- price: Prezzo della variante.
- compare_at_price: Prezzo di confronto della variante.
- handling_charges: Spese di gestione della variante.
- charge_taxes: Se vengono applicate tasse (0 per no, 1 per sì).
- require_shipping: Se la spedizione è richiesta (0 per no, 1 per sì).
- track_inventory: Se l’inventario è tracciato (0 per no, 1 per sì).
- quantity: Quantità disponibile della variante.
- inventory_policy: Politica di inventario (0 per continuare a vendere, 1 per fermare)
- options: Opzioni del prodotto come titoli o valori.
- name: Nome dell’opzione.
- values: Valori dell’opzione.
- images: Immagini del prodotto.
- image_url: URL dell’immagine.
- image_alt: Testo alternativo per l’immagine.
- position: Posizione dell’immagine.
- image_attachment: Allegato dell’immagine.
Categorizzazione del prodotto: product_type
Il campo product_type è un campo obbligatorio necessario a collocare il prodotto all’interno della giusta categoria su commercioVirtuoso.it.
Il campo product_type è ristretto a valori definiti. Puoi consultare l’elenco aggiornato dei nodi di categoria interrogando l’api all’Endpoint GET /api/v2/products/types.json
E’ necessario utilizzare valore restituito nel campo “type_name”, non l’id del product_type.
E’ possibile anche utilizzare il motore di categorizzazione automatica di commercioVirtuoso.it, in tal caso è possibile passare il valore statico “Gestione/Autocategorizzazione“
Response della chiamata
Il codice 200 è restituito in caso di creazione del prodotto avvenuta con successo. Il Body della risposta contiene anche il valore id prodotto e id variante assegnati, utili per le operazioni di aggiornamento successive
