Le API ShippyPro sono il modo più semplice per integrare il tuo sistema con oltre 140 Corrieri in tutto il mondo per spedire i tuoi pacchi.
Vediamo come funzionano le API passo dopo passo 🔍
1. Prima di iniziare
Per iniziare a utilizzare l'API ShippyPro, è necessario innanzitutto:
Creare un account ShippyPro cliccando qui. Se desideri sapere come creare un account passo dopo passo, clicca qui.
Connettere i tuoi account Corrieri da Corrieri > Connessione. Per maggiori dettagli, leggi l’articolo Come connettere i Corrieri.
Dopo aver impostato il tuo profilo ShippyPro, leggi la nostra API-Documentation attentamente. Troverai tutte le informazioni necessarie per utilizzare le nostre API.
Puoi decidere di attivare una Cartella Ordini API per poter gestire le tue spedizioni API direttamente dalla piattaforma, scopri qui come fare.
📌 Non dimenticare di dare un'occhiata alla nostra Marketplace API per importare i dettagli dei tuoi ordini su ShippyPro.
2. API ShippyPro
Le nostre API sono scritte per essere RESTful.
Troverai la tua Chiave API cliccando su Integrazioni > API.
Dopo aver copiato la chiave API, segui la procedura di attivazione menzionata qui:
Documentazione API > Authentication.
Ricorda di impostare Username e Password come segue:
Username: La tua API KEY as Username
Password: il campo deve essere lasciato vuoto
3. ShippyPro API
Qui di seguito le richieste API più frequenti:
- GET RATES
ShippyPro RATE API ti permette di ottenere le tariffe dei tuoi corrieri ordinate per prezzo con una semplice richiesta API. Saranno inclusi anche i giorni di consegna stimati.
📌 Le tariffe Corriere dipenderanno da quelle previste dal tuo contratto con lo stesso, trovi qui come poterle aggiungere al tuo profilo ShippyPro.
- SHIP
Ship ti permette di spedire i tuoi ordini e generare etichette di spedizione nel formato impostato sul profilo per qualsiasi corriere supportato.
📌 Attenzione: Le Chiamate Ship e Edit genereranno etichette di spedizione REALI e scalate dalle 30 previste ogni mese. Ti consigliamo di utilizzare il Corriere Generic per testare queste chiamate.
📌 Attenzione: I valori CarrierName, CarrierService e CarrierID dovranno essere ripresi da qui:
Ricorda che se inserisci Async = true, dovrai usare un Webhook per generare un'etichetta.
- TRACKING
Con questa API, puoi tracciare le tue spedizioni e ricevere notifiche ad un webhook ogni volta che la spedizione cambia stato.
Scopri tutte le altre nella nostra sezione dell'Help dedicata!
Da Integrazioni > API, clicca su Visualizza Log API per vedere le richieste e risposte API in tempo reale.
Facendo invece click su Errori API, è possibile consultare tutta la cronologia degli errori riscontrati.
Tramite i Webhook Logs, inserendo il tuo endpoint riceverai una notifica in caso di modifiche allo stato di consegna e potrai accedere a informazioni utili sugli aggiornamenti di tracking.
📌 I file API (Request + Response) e i Webhook sono in formato Json.
4. Come posso testare le API di ShippyPro?
Puoi testare le nostre API usando il corriere Generic. E' un corriere fittizio, creato appositamente per la fase di test.
📌 Attenzione: Tieni presente che dato che Generic non è un Corriere reale, non è possibile generare un numero di tracking valido. Scopri come usare Corriere Generico facendo click qui.