Spedity aiuta le aziende a confrontare le tariffe di corrieri e trasportatori per evadere ogni tipo di ordine, dalla piccola spedizione al trasporto dedicato, rapidamente e al costo più basso.

Prerequisiti

Per poter utilizzare le API di Spedity è necessario possedere un account cliente PRO sulla piattaforma pro.spedity.com, in particolare è necessario seguire i seguenti passi:

Registrarsi alla piattaforma come cliente
Richiedere tramite email o contatto al centro assistenza il passaggio a cliente PRO
Reperire il token di autenticazione presente nel proprio profilo

Note tecniche

L' API restituisce risposte JSON-encoded.
Le API differiscono per ogni versione rilasciata, fai attenzione al numero di versione a cui fai riferimento.
L'autenticazione avviene con un token che deve essere passato tramite l'header 'token'.

Utilizzo delle API

Attualmente sono disponibili 2 API per la richiesta e la consultazione di preventivi di spedizione.

Quote

Consente di creare una richiesta di preventivi di spedizione. I preventivi per cui è possibile emettere subito una quotazione vengono restituiti in tempo reale. E' possibile verificare la presenza di ulteriori preventivi chiamato l'API "quote-refresh".
Le chiamate API creano un preventivo anche nell'interfaccia utente della piattaforma, dal quale sarà possibile concludere il processo di acquisto.
Richiede di specificare lo stato ed il cap dei punti di ritiro e consegna oltre alla descrizione della merce spedita.
E' necessario specificare peso e dimensioni della marce o, in alternativa, il tipo di mezzo richiesto (se si vuole prenotare un mezzo dedicato).
La richiesta vanno inviati tramite body Json nel seguente formato:

	{
		"pickupPostalCode": "00042",
		"pickupCountry": "IT",
		"deliveryPostalCode": "10123",
		"deliveryCountry": "IT",
		"serviceType": "item",
		"items": [
			{
				"itemType": "box",
				"quantity": 1,
				"weight": 20,
				"width": 30,
				"length": 30,
				"height": 30
			}
		]
	}

E' necessario specificare la chiave "serviceType" indicando uno dei due valori:

item: spedizione di merce in scatole o pallet truck: richiesta mezzo dedicato

Nel caso di spedizione di tipo item (scatole o pallet) è necessario indicare nella chiave "items" un array di oggetti così stutturati:

itemType: possibili valori box o pallet
quantity: quantità della merce (intero)
weight: peso in kg (intero)
width: larghezza in cm (intero)
length: lunghezza in cm (intero)
height: altezza in cm (intero)

Indicare più oggetti sottointende che si vuole procedere con una spedizione unica per tutti gli oggetti.
Nel caso di richiesta mezzo è necessario specificare la chiave "truckType" con i seguenti valori:

truckType: plane (camion telonato), box (furgone), frigo (mezzo refrigerato)

L'API restituisce un Json come il seguente:

	{
		"id": "4ffcb6c3-8164-4350-83f4-ba5f857a9ab5",
		"url": "http://127.0.0.1:81/proposal/4ffcb6c3-8164-4350-83f4-ba5f857a9ab5",
		"quote": [
			{
				"id": "6f855bf7-61d9-402c-9779-662b5c618515",
				"order_url": "http://127.0.0.1:81/proposal/4ffcb6c3-8164-4350-83f4-ba5f857a9ab5/select/quoter-test-trasportatore-2-modificato-tariffa-2",
				"name": "Test trasportatore 2 modificato",
				"quote": "2.00"
			},
			{
				"id": "af01310d-6c27-48c8-a3b6-f94104c3dd9d",
				"order_url": "http://127.0.0.1:81/proposal/4ffcb6c3-8164-4350-83f4-ba5f857a9ab5/select/quoteandgo-prem",
				"name": "Net Premium",
				"quote": "285.00"
			},
			{
				"id": "d3a81d65-5772-449b-b49f-a98cafd9af35",
				"order_url": "http://127.0.0.1:81/proposal/4ffcb6c3-8164-4350-83f4-ba5f857a9ab5/select/quoteandgo-eco",
				"name": "Net Economy",
				"quote": "228.00"
			}
		]
	}

La risposta è così strutturata:

L'id rappresenta l'identificativo della richiesta di preventivi (da usare in tutte le successive chiamate)
La chiave url indica la pagina della piattaforma per accedere direttamente all'elenco dei preventivi
L'id dei sottoelementi quote è necessario in eventuali chiamate successive
La chiave order_url riporta l'indirizzo da chiamare per procedere all'acquisto della specifica soluzione
I prezzi sono specificati iva esclusa

Quote Refresh

Consente di riottenere l'elenco delle soluzioni proposte per la specifica richiesta di preventivi.
L'API utilizza il metodo GET ed il parametro necessario è l'id ottenuto dalla chiamata "quote".
Il json di risposta è identico a quello della chiamata precedente.
La dati contenuti nel json potrebbero essere aggiornati con nuovi preventivi emessi successivamente alla prima chiamata.