Per sviluppatori

API REST YOUCART

Ogni cosa che si fa dal pannello si può fare via API: catalogo, ordini, magazzino, resi. 225 endpoint JSON, inclusi in tutti i piani, senza limiti di chiamate.

Questa pagina è generata dalla stessa tabella di rotte che il server carica all'avvio: se un endpoint è elencato qui, esiste.

Prima di cominciare

L'indirizzo è quello del negozio

Non esiste un endpoint centrale: ogni negozio risponde sul proprio sottodominio, e il negozio viene riconosciuto dall'indirizzo della richiesta, non da un parametro.

https://tuonegozio.youcart.it/api/v1/…

È la ragione per cui una credenziale di un negozio non funziona sull'indirizzo di un altro: viene rifiutata con 401, anche se è valida a casa sua.

Due modi di autenticarsi

Per integrare un altro programma si usa una chiave API. Il token JWT serve alle applicazioni che agiscono per conto di una persona collegata, come la vetrina.

Chiave API — per i programmi

Si emette dal pannello del negozio, sezione Chiavi API. Va nell'intestazione X-Api-Key:

curl -H "X-Api-Key: yc_a1b2c3…" \
  https://tuonegozio.youcart.it/api/v1/youcart/prodotti

Tre cose da sapere sulle chiavi

  • Si vede una volta sola. Alla creazione. Non è recuperabile: nel database c'è solo il suo hash. Se la perdi, ne emetti un'altra.
  • Nasce in sola lettura. La scrittura si concede esplicitamente al momento dell'emissione. Una chiave senza quel permesso riceve 403 sugli endpoint di scrittura.
  • Non tocca le credenziali. Nemmeno con la scrittura: una chiave non può emettere altre chiavi né riconfigurare l'SMTP del negozio. Così revocarla basta davvero a chiudere l'accesso.

Token JWT — per conto di una persona

Si ottiene da POST /api/v1/auth/login e dura 30 minuti. Va in Authorization:

curl -H "Authorization: Bearer <token>" \
  https://tuonegozio.youcart.it/api/v1/auth/me

Il formato delle risposte

Sempre lo stesso, in caso di successo e di errore.

// riuscita
{ "success": true, "data": { … } }

// fallita — "errori" è sempre una lista
{ "success": false,
  "errori": [ { "codice": "VALIDATION", "messaggio": "…" } ] }

Codici che vale la pena distinguere

CodiceSignificaCosa fare
401Credenziale assente, scaduta o di un altro negozioRifai il login o controlla l'indirizzo
403Riconosciuto, ma senza il permessoServe una chiave con scrittura, o un amministratore
402Il piano del negozio non comprende la funzionalitàNon è un errore tecnico: il messaggio dice da quale piano è disponibile
404Non esiste, o non appartiene a questo negozioI due casi non si distinguono, di proposito
409Conflitto: già esistente, o già in quello statoRileggi lo stato attuale prima di riprovare

Il 402 è quello che sorprende di più: un endpoint può esistere, la credenziale essere giusta, e la risposta essere comunque un rifiuto perché quella funzionalità appartiene a un piano superiore. Nella tabella qui sotto gli endpoint interessati portano l'indicazione del piano minimo.

Convenzioni

  • Identificativi: esadecimali a 32 caratteri maiuscoli (A1B2…). Il confronto è sensibile: usali come li ricevi.
  • Paginazione: ?pagina=1&per_pagina=24, massimo 100 per pagina. La risposta riporta pagina, per_pagina e totale.
  • Importi: stringhe decimali, nella valuta del negozio — non è sempre l'euro. L'IVA è scomposta per aliquota.
  • I prezzi non si inviano: prezzo, sconto e costo di spedizione vengono sempre riletti dal catalogo lato server. Un importo nel corpo della richiesta viene ignorato.
  • Corpo: JSON, Content-Type: application/json.
Riferimento

Tutti gli endpoint

pubblico nessuna credenziale · collegato chiave API o token · amministratore chiave con scrittura, o admin

Stato del servizio

MetodoPercorsoAccesso
GET/api/v1/healthpubblico

Accesso e password

MetodoPercorsoAccesso
POST/api/v1/auth/registerpubblico
POST/api/v1/auth/loginpubblico
POST/api/v1/auth/logoutpubblico
GET/api/v1/auth/mecollegato
PUT/api/v1/auth/passwordcollegato
POST/api/v1/auth/password/dimenticatapubblico
POST/api/v1/auth/password/reimpostapubblico

Catalogo (pubblico)

MetodoPercorsoAccesso
GET/api/v1/youcart/prodottipubblico
GET/api/v1/youcart/prodotti/ricercapubblico
GET/api/v1/youcart/prodotti/categoriepubblico
GET/api/v1/youcart/prodotti/marchepubblico
GET/api/v1/youcart/prodotti/csvpubblico
GET/api/v1/youcart/prodotti/{slug}pubblico
GET/api/v1/youcart/prodotti/{slug}/correlatipubblico
GET/api/v1/youcart/categoriepubblico
GET/api/v1/youcart/categorie/{slug}pubblico
GET/api/v1/youcart/prodotti-abitualicollegato

Carrello

MetodoPercorsoAccesso
GET/api/v1/youcart/carrellopubblico
POST/api/v1/youcart/carrello/itemspubblico
PATCH/api/v1/youcart/carrello/items/{id}pubblico
DELETE/api/v1/youcart/carrello/items/{id}pubblico
GET/api/v1/youcart/admin/carrelli-abbandonatiamministratore
GET/api/v1/youcart/admin/carrelli-abbandonati/csvamministratore

Ordini

MetodoPercorsoAccesso
POST/api/v1/youcart/ordinicollegato
GET/api/v1/youcart/ordinicollegato
GET/api/v1/youcart/admin/ordini/csvamministratore
GET/api/v1/youcart/ordini/{id}collegato
PUT/api/v1/youcart/admin/ordini/{id}/fatturazioneamministratore
PUT/api/v1/youcart/admin/ordini/{id}/note-interneamministratore
PUT/api/v1/youcart/admin/ordini/righe/{riga}/consegnaamministratore
PUT/api/v1/youcart/admin/ordini/{id}/evasioneamministratore
POST/api/v1/youcart/ordini/{id}/riordinacollegato
PUT/api/v1/youcart/admin/ordini/{id}/annullaamministratore

Notifiche email

MetodoPercorsoAccesso
GET/api/v1/youcart/notifiche-emailcollegato
POST/api/v1/youcart/notifiche-emailcollegato
PUT/api/v1/youcart/notifiche-email/{id}collegato
DELETE/api/v1/youcart/notifiche-email/{id}collegato

Preventivi

MetodoPercorsoAccesso
POST/api/v1/youcart/preventivicollegatoda Pro
GET/api/v1/youcart/preventivicollegato
GET/api/v1/youcart/preventivi/{id}collegato
DELETE/api/v1/youcart/preventivi/{id}collegato
GET/api/v1/youcart/preventivi/{id}/csvcollegato
GET/api/v1/youcart/admin/preventivi/csvamministratoreda Pro
PUT/api/v1/youcart/preventivi/{id}/esitocollegato
PUT/api/v1/youcart/admin/preventivi/{id}/rispostaamministratoreda Pro

Promozioni

MetodoPercorsoAccesso
GET/api/v1/youcart/admin/promozioniamministratoreda Pro
POST/api/v1/youcart/admin/promozioniamministratoreda Pro
PUT/api/v1/youcart/admin/promozioni/{id}amministratoreda Pro
PUT/api/v1/youcart/admin/promozioni/{id}/attivaamministratoreda Pro
GET/api/v1/youcart/admin/promozioni/csvamministratoreda Pro

Registro operazioni

MetodoPercorsoAccesso
GET/api/v1/youcart/admin/registroamministratore
GET/api/v1/youcart/admin/registro/csvamministratore

Spedizione (pubblico)

MetodoPercorsoAccesso
GET/api/v1/youcart/spedizione/zonepubblico
GET/api/v1/youcart/spedizione/preventivopubblico

Spedizione (amministrazione)

MetodoPercorsoAccesso
POST/api/v1/youcart/admin/spedizione/zoneamministratore
PUT/api/v1/youcart/admin/spedizione/zone/{id}amministratore
DELETE/api/v1/youcart/admin/spedizione/zone/{id}amministratore
GET/api/v1/youcart/spedizione/tariffepubblico
POST/api/v1/youcart/admin/spedizione/tariffeamministratore
PUT/api/v1/youcart/admin/spedizione/tariffe/{id}amministratore
DELETE/api/v1/youcart/admin/spedizione/tariffe/{id}amministratore

Negozio e configurazione

MetodoPercorsoAccesso
GET/api/v1/youcart/negozio/impostazionipubblico
POST/api/v1/youcart/contattipubblico
PUT/api/v1/youcart/admin/negozio/impostazioniamministratore
PUT/api/v1/youcart/admin/negozio/promemoria-carrelloamministratore
GET/api/v1/youcart/admin/negozio/smtpamministratore
PUT/api/v1/youcart/admin/negozio/smtpamministratore
POST/api/v1/youcart/admin/negozio/smtp/provaamministratore
GET/api/v1/youcart/admin/negozio/email/codaamministratore
GET/api/v1/youcart/admin/negozio/profiloamministratore
PUT/api/v1/youcart/admin/negozio/profiloamministratore
GET/api/v1/youcart/admin/negozio/visiteamministratore
GET/api/v1/youcart/admin/negozio/ricerche-senza-risultatoamministratore
PUT/api/v1/youcart/admin/negozio/blocca-fuori-fidoamministratore
GET/api/v1/youcart/admin/negozio/conversione-prodottiamministratore
GET/api/v1/youcart/admin/negozio/trafficoamministratore
GET/api/v1/youcart/admin/negozio/venditeamministratore
GET/api/v1/youcart/admin/negozio/prodotti-vendutiamministratore
GET/api/v1/youcart/admin/negozio/temaamministratoreda Premium
PUT/api/v1/youcart/admin/negozio/temaamministratoreda Premium
PUT/api/v1/youcart/admin/negozio/tema/bozzaamministratoreda Premium
POST/api/v1/youcart/admin/negozio/tema/bozza/pubblicaamministratoreda Premium
DELETE/api/v1/youcart/admin/negozio/tema/bozzaamministratoreda Premium
POST/api/v1/youcart/admin/negozio/tema/logoamministratoreda Premium
DELETE/api/v1/youcart/admin/negozio/tema/logoamministratoreda Premium
POST/api/v1/youcart/admin/negozio/tema/immagine/{tipo}amministratoreda Premium
DELETE/api/v1/youcart/admin/negozio/tema/immagine/{tipo}amministratoreda Premium
GET/api/v1/youcart/admin/negozio/lingueamministratoreda Business
PUT/api/v1/youcart/admin/negozio/lingueamministratoreda Business
GET/api/v1/youcart/admin/traduzioni/{entita}/{id}amministratoreda Business
PUT/api/v1/youcart/admin/traduzioni/{entita}/{id}amministratoreda Business

Pagine

MetodoPercorsoAccesso
GET/api/v1/youcart/paginepubblico
GET/api/v1/youcart/pagine/{slug}pubblico
GET/api/v1/youcart/admin/pagineamministratore
POST/api/v1/youcart/admin/pagineamministratore
GET/api/v1/youcart/admin/pagine/{id}amministratore
PUT/api/v1/youcart/admin/pagine/{id}amministratore
DELETE/api/v1/youcart/admin/pagine/{id}amministratore

Rubrica indirizzi

MetodoPercorsoAccesso
GET/api/v1/youcart/indirizzicollegato
POST/api/v1/youcart/indirizzicollegato
PUT/api/v1/youcart/indirizzi/{id}collegato
DELETE/api/v1/youcart/indirizzi/{id}collegato

Pagamenti

MetodoPercorsoAccesso
GET/api/v1/youcart/admin/pagamentiamministratore
PUT/api/v1/youcart/admin/pagamenti/{id}/incassoamministratore
PUT/api/v1/youcart/admin/pagamenti/{id}/annullaamministratore

Anagrafica B2B

MetodoPercorsoAccesso
GET/api/v1/youcart/admin/contattiamministratoreda Business
GET/api/v1/youcart/admin/contatti/csvamministratoreda Business
GET/api/v1/youcart/admin/contatti/{id}/serialiamministratoreda Business
GET/api/v1/youcart/admin/contatti/{id}amministratoreda Business
POST/api/v1/youcart/admin/contattiamministratoreda Business
PUT/api/v1/youcart/admin/contatti/{id}amministratoreda Business
PUT/api/v1/youcart/admin/contatti/{id}/utenteamministratoreda Business
POST/api/v1/youcart/admin/contatti/verifica-pivaamministratoreda Business

Listini B2B

MetodoPercorsoAccesso
GET/api/v1/youcart/admin/listiniamministratoreda Premium
GET/api/v1/youcart/admin/listini/{id}/csvamministratoreda Premium
POST/api/v1/youcart/admin/listini/{id}/importamministratoreda Premium
GET/api/v1/youcart/admin/listini/{id}amministratoreda Premium
POST/api/v1/youcart/admin/listiniamministratoreda Premium
PUT/api/v1/youcart/admin/listini/{id}amministratoreda Premium
DELETE/api/v1/youcart/admin/listini/{id}amministratoreda Premium
PUT/api/v1/youcart/admin/listini/{id}/voceamministratoreda Premium
DELETE/api/v1/youcart/admin/listini/{id}/voce/{voce}amministratoreda Premium

Catalogo (amministrazione)

MetodoPercorsoAccesso
POST/api/v1/youcart/admin/prodottiamministratore
POST/api/v1/youcart/admin/prodotti/importa-csvamministratore
PUT/api/v1/youcart/admin/prodotti/{id}amministratore
DELETE/api/v1/youcart/admin/prodotti/{id}amministratore
POST/api/v1/youcart/admin/prodotti/{id}/duplicaamministratore
GET/api/v1/youcart/admin/prodotti/ricerche-logamministratore
GET/api/v1/youcart/admin/ricerche/csvamministratore
GET/api/v1/youcart/admin/prodotti/{id}/variantiamministratore
POST/api/v1/youcart/admin/prodotti/{id}/variantiamministratore
PUT/api/v1/youcart/admin/prodotti/{id}/varianti/{variante}amministratore
DELETE/api/v1/youcart/admin/prodotti/{id}/varianti/{variante}amministratore
GET/api/v1/youcart/admin/prodotti/{id}/immaginiamministratore
POST/api/v1/youcart/admin/prodotti/{id}/immaginiamministratore
DELETE/api/v1/youcart/admin/prodotti/{id}/immagini/{immagine}amministratore
GET/api/v1/youcart/admin/prodotti/{id}/file-digitaliamministratore
POST/api/v1/youcart/admin/prodotti/{id}/file-digitaliamministratore
DELETE/api/v1/youcart/admin/prodotti/{id}/file-digitali/{file}amministratore
PUT/api/v1/youcart/admin/prodotti/{id}/immagini/{immagine}/principaleamministratore
GET/api/v1/youcart/admin/prodotti/{id}/impieghiamministratore
GET/api/v1/youcart/admin/prodotti/{id}/attributiamministratore
PUT/api/v1/youcart/admin/prodotti/{id}/attributiamministratore

Categorie (amministrazione)

MetodoPercorsoAccesso
POST/api/v1/youcart/admin/categorieamministratore
PUT/api/v1/youcart/admin/categorie/{id}amministratore
DELETE/api/v1/youcart/admin/categorie/{id}amministratore

Magazzino

MetodoPercorsoAccesso
GET/api/v1/youcart/admin/magazziniamministratoreda Pro
POST/api/v1/youcart/admin/magazziniamministratoreda Premium
GET/api/v1/youcart/admin/giacenzeamministratoreda Pro
GET/api/v1/youcart/admin/magazzino/giacenze/csvamministratoreda Pro
GET/api/v1/youcart/admin/magazzino/movimentiamministratoreda Premium
GET/api/v1/youcart/admin/magazzino/movimenti/csvamministratoreda Premium
POST/api/v1/youcart/admin/magazzino/movimentiamministratoreda Premium
PUT/api/v1/youcart/admin/magazzino/scortaamministratoreda Pro

Resi (cliente)

MetodoPercorsoAccesso
GET/api/v1/youcart/rmacollegato
POST/api/v1/youcart/rmacollegato
GET/api/v1/youcart/rma/{id}collegato
POST/api/v1/youcart/rma/{id}/annullacollegato
POST/api/v1/youcart/rma/{id}/spedizionecollegato

Resi (amministrazione)

MetodoPercorsoAccesso
GET/api/v1/youcart/admin/rma/csvamministratore
POST/api/v1/youcart/admin/rma/{id}/accettaamministratore
POST/api/v1/youcart/admin/rma/{id}/rifiutaamministratore
POST/api/v1/youcart/admin/rma/{id}/riceviamministratore
POST/api/v1/youcart/admin/rma/{id}/ispezionaamministratoreda Business
POST/api/v1/youcart/admin/rma/{id}/risolviamministratoreda Business
POST/api/v1/youcart/admin/rma/{id}/chiudiamministratore

Assistenza (cliente)

MetodoPercorsoAccesso
GET/api/v1/youcart/assistenzacollegatoda Pro
POST/api/v1/youcart/assistenzacollegatoda Pro
GET/api/v1/youcart/assistenza/{id}collegatoda Pro
POST/api/v1/youcart/assistenza/{id}/messaggicollegatoda Pro
PUT/api/v1/youcart/assistenza/{id}/statocollegatoda Pro

Assistenza (amministrazione)

MetodoPercorsoAccesso
GET/api/v1/youcart/admin/assistenza/csvamministratoreda Pro
GET/api/v1/youcart/admin/assistenza/operatoriamministratoreda Pro
PUT/api/v1/youcart/admin/assistenza/{id}/assegnaamministratoreda Pro

Account clienti

MetodoPercorsoAccesso
GET/api/v1/youcart/admin/account-clientiamministratore
GET/api/v1/youcart/admin/account-clienti/csvamministratore
GET/api/v1/youcart/admin/account-clienti/{id}/serialiamministratoreda Business
PUT/api/v1/youcart/admin/account-clienti/{id}/sospendiamministratore
GET/api/v1/youcart/admin/account-clienti/{id}amministratore

Prenotazioni admin

MetodoPercorsoAccesso
GET/api/v1/youcart/admin/prenotazioniamministratoreda Pro
PUT/api/v1/youcart/admin/prenotazioni/{id}/statoamministratoreda Pro
GET/api/v1/youcart/admin/prenotazioni/csvamministratoreda Pro
GET/api/v1/youcart/admin/disponibilitaamministratoreda Pro
POST/api/v1/youcart/admin/disponibilitaamministratoreda Pro
DELETE/api/v1/youcart/admin/disponibilita/{id}amministratoreda Pro

Prenotazioni pubbliche

MetodoPercorsoAccesso
GET/api/v1/youcart/prodotti/{slug}/disponibilitapubblico

Amministratori admin

MetodoPercorsoAccesso
GET/api/v1/youcart/admin/amministratoriamministratore
POST/api/v1/youcart/admin/amministratoriamministratore
POST/api/v1/youcart/admin/amministratori/{id}/reinvitaamministratore
PUT/api/v1/youcart/admin/amministratori/{id}/sospendiamministratore

Chiavi API

MetodoPercorsoAccesso
GET/api/v1/youcart/admin/chiavi-apiamministratore
POST/api/v1/youcart/admin/chiavi-apiamministratore
DELETE/api/v1/youcart/admin/chiavi-api/{id}amministratore

Pagamenti online

MetodoPercorsoAccesso
GET/api/v1/youcart/admin/pagamenti/configurazioneamministratore
PUT/api/v1/youcart/admin/pagamenti/configurazioneamministratore
POST/api/v1/youcart/ordini/{id}/pagacollegato
POST/api/v1/youcart/pagamenti/notificapubblico
GET/api/v1/youcart/pagamenti/notificapubblico

Domini admin

MetodoPercorsoAccesso
GET/api/v1/youcart/admin/dominiamministratore
POST/api/v1/youcart/admin/dominiamministratore
POST/api/v1/youcart/admin/domini/{id}/verificaamministratore
DELETE/api/v1/youcart/admin/domini/{id}amministratore

Abbonamenti admin

MetodoPercorsoAccesso
GET/api/v1/youcart/admin/abbonamentiamministratoreda Pro
GET/api/v1/youcart/admin/abbonamenti/csvamministratoreda Pro
POST/api/v1/youcart/admin/abbonamentiamministratoreda Pro
PUT/api/v1/youcart/admin/abbonamenti/{id}amministratoreda Pro
PUT/api/v1/youcart/admin/abbonamenti/{id}/disdiciamministratoreda Pro
PUT/api/v1/youcart/admin/abbonamenti/{id}/sospendiamministratoreda Pro
POST/api/v1/youcart/admin/abbonamenti/{id}/rinnovaamministratoreda Pro

Abbonamenti pubblici

MetodoPercorsoAccesso
GET/api/v1/youcart/abbonamenticollegato

Seriali admin

MetodoPercorsoAccesso
GET/api/v1/youcart/admin/serialiamministratoreda Business
GET/api/v1/youcart/admin/seriali/csvamministratoreda Business
GET/api/v1/youcart/admin/seriali/in-scadenzaamministratoreda Business
POST/api/v1/youcart/admin/serialiamministratoreda Business
PUT/api/v1/youcart/admin/seriali/{id}/assegnaamministratoreda Business
POST/api/v1/youcart/admin/seriali/richiamaamministratoreda Business
GET/api/v1/youcart/admin/seriali/ordine/{ordine}amministratoreda Business

Seriali pubblici

MetodoPercorsoAccesso
GET/api/v1/youcart/miei-serialicollegato

Accessi admin

MetodoPercorsoAccesso
GET/api/v1/youcart/admin/accessiamministratore
PUT/api/v1/youcart/admin/accessi/{id}amministratore
PUT/api/v1/youcart/admin/accessi/{id}/revocaamministratore
GET/api/v1/youcart/admin/accessi-digitali/csvamministratore

Accessi pubblici

MetodoPercorsoAccesso
GET/api/v1/youcart/accesso/{token}pubblico
GET/api/v1/youcart/accesso/{token}/scaricapubblico

Serve una mano con l'integrazione?

Scrivici con il caso d'uso: ti diciamo quali endpoint servono e se qualcosa va costruito.