Connettore Shippo

Integrazione con l'API di Shippo

Introduzione

Shippo è un'API e una web-app per spedizioni multi-vettore che include vettori come USPS, DHL, FedEx e molti altri. I clienti possono ottenere tariffe di spedizione, stampare etichette, automatizzare i documenti internazionali, tracciare le spedizioni e facilitare i resi.

Scopo

Questa integrazione evidenzia come sia possibile sfruttare le funzioni del connettore HTTP di Tulip per integrarsi con l'API di Shippo e automatizzare la creazione di spedizioni, ottenere una serie di tariffe da una serie di vettori, scegliere la tariffa migliore e infine creare e stampare un'etichetta di spedizione con la possibilità di tracciare le spedizioni. Tutto questo può essere fatto dalla vostra applicazione Tulip. A seconda dei diversi casi d'uso, l'integrazione con Tulip può essere sfruttata per avere il controllo sulle operazioni della propria supply-chain e avere visibilità in tempo reale sulla spedizione dei pacchi.

Documentazione API

Documentazione API Shippo

Prerequisiti

Creare un account sul sito web di Shippo e generare i token API che saranno utilizzati come intestazioni di autorizzazione in tutte le chiamate effettuate all'API di Shippo. Shippo consente di generare un token di prova e un token live. Il token di prova può essere utilizzato per effettuare chiamate HTTP di prova con l'API e progettare la vostra applicazione Tulip; una volta che l'applicazione è pronta, i token possono essere scambiati e le applicazioni possono essere distribuite in produzione per generare etichette di spedizione e transazioni in tempo reale.

Dettagli della connessione Tulip

Il connettore HTTP di Tulip deve essere configurato con i seguenti dettagli per stabilire una connessione con Shippo.

1. In esecuzione su: Host del connettore cloud
2. Host: api.goshippo.com
3. Porta:443
4. TLS:Sì
5. I token di Shippo come intestazione di autorizzazione possono essere passati tramite la funzione del connettore.

Funzione Connector

Crea spedizione

Scopo

1. Questa funzione del connettore crea una nuova spedizione effettuando una chiamata POST all'API di Shippo con i dettagli del mittente, del destinatario e del pacchetto come parte del corpo della richiesta.
2. Quando la creazione ha successo, Shippo restituisce un oggetto JSON che include lo stato della spedizione creata insieme a una scelta di tariffe di diversi fornitori che gli utenti possono sfruttare per andare avanti e avviare una transazione. Gli utenti possono selezionare la tariffa giusta, avere gli ID delle tariffe memorizzati nelle variabili Tulip che vengono passate dinamicamente per creare la transazione e generare l'etichetta della spedizione nella funzione del connettore corrispondente.

Punto finale

1. Chiamata HTTP POST all'endpoint: https://api.goshippo.com:443/shipments/

Intestazione di autorizzazione

Per effettuare l'autenticazione con l'API di Shippo, il token HTTP di Shippo deve essere inserito nell'intestazione della richiesta. Il formato è il seguente

Autorizzazione : ShippoToken ($ShippoToken$)

Input richiesti

I seguenti sono i parametri di input che vengono passati nel corpo della richiesta, dove il tipo di contenuto è JSON.

1. Nome del mittente, via, città, stato, codice postale, paese.
2. Nome del destinatario, via, città, stato, codice postale, paese.
3. Dimensioni del pacco: lunghezza, larghezza, larghezza e peso.

Estrattore di output richiesto

Vengono restituite molte informazioni per l'oggetto Spedizione creato, ma i campi importanti da estrarre sono i seguenti

1. Stato: Indica se la spedizione è stata creata con successo
2. ID spedizione: Può essere consultato per ottenere i dettagli della spedizione creata.
3. Opzioni tariffa: Array di oggetti che indicano le diverse opzioni delle tariffe fornite dai diversi fornitori. L'ID tariffa è una chiave importante tra le altre da estrarre, che verrà passata per creare la transazione effettiva per questa spedizione.

Crea transazione

Scopo

1. Questa funzione del connettore crea la transazione dopo aver scelto il fornitore e la tariffa finale tra le diverse opzioni restituite al momento della creazione di una nuova spedizione nella precedente funzione del connettore.
2. La transazione viene stabilita effettuando una chiamata HTTP POST all'endpoint di Shippo, passando l'ID associato alla tariffa decisa. Se la chiamata va a buon fine, Shippo restituisce un oggetto JSON che include lo stato della transazione, l'ID di tracciamento, l'etichetta di spedizione e l'URL di tracciamento, oltre ad altre informazioni. L'etichetta di spedizione restituita può essere stampata direttamente dall'applicazione Tulip.

Punto finale

1. Chiamata HTTP POST all'endpoint: https://api.goshippo.com:443/transactions/

Intestazione di autorizzazione

Per effettuare l'autenticazione con l'API di Shippo, il token HTTP di Shippo deve essere inserito nell'intestazione della richiesta. Il formato è il seguente

Autorizzazione : ShippoToken ($ShippoToken$)

Input richiesti

I seguenti sono i parametri di input che vengono passati nel corpo della richiesta, dove il tipo di contenuto è JSON.

1. ID tariffa: viene passato l'ID della tariffa scelta per procedere al fine di creare una transazione di successo.

Estrattore di output richiesto

Vengono restituite molte informazioni per l'oggetto Spedizione creato, tuttavia i campi importanti da estrarre sono i seguenti

1. Stato: Indica se la transazione è stata creata con successo
2. ID transazione: Può essere consultato per ottenere i dettagli della transazione eseguita.
3. Numero di tracciamento: Per tracciare la spedizione
4. URL di tracciamento: L'URL della pagina di tracciamento del venditore scelto
5. URL dell'etichetta: Etichetta di spedizione che può essere incorporata nell'applicazione Tulip per la stampa.