Shipment
Gestione delle spedizioni
Shipment - GET
Questo endpoint permette di gestire la creazione, recupero e la cancellazione delle spedizioni su Gsped.
Shipment -GET
GET
https://api.gsped.it/[ISTANZA]/Shipment
Recupera tutte le informazioni di una spedizione compre le etichette
Query Parameters
id*
String
ID univoco Gsped della spedizione
Headers
x-api-key*
String
Apikey fornita da GSPED
Snippets codice di esempio
Shipment - POST
La chiamata Shipment Post permette di creare la spedizione.
Se l’operazione ha esito positivo, restituisce i dati della spedizione insieme alle relative etichette nei formati disponibili.
La logica da implementare per controllare l'esito delle chiamate è la seguente:
sulla risposta delle API sulla POST di creazione spedizione va innanzitutto controllato il codice di risposta HTTP, se è 400 i dati passati non hanno passato la prima serie di controlli sui dati, in quel caso il campo error contiene indicazioni sul problema riscontrato (ad esempio campi obbligatori mancanti).
Se il codice di risposta è 200 i dati hanno passato il primo livello di validazione ed è stata avviata la generazione della lettera di vettura. Andrà quindi verificato il valore del campo status, se contiene 0 la lettera di vettura è stata generata correttamente e potrà essere recuperata dai campi preposti nella risposta. Se invece il campo status è uguale a 0.6 la generazione della lettera di vettura è fallita e il campo error conterrà la descrizione dell’errore. Questo tipo di errori si può verificare per situazioni tipo cap e località non coerenti, indirizzo non accettato dai sistemi del corriere, servizio richiesto non disponibile per la località di destinazione et cetera.
Shipment POST
POST
https://api.gsped.it/[ISTANZA]/Shipment
Creazione di una spedizione
Headers
x-api-key*
String
Apikey rilasciata da Gsped
Request Body
corriere*
Int
colli*
Int
Numero colli della spedizione
volume*
Float
Volume spedizione in Metri Cubi
peso*
Float
Peso spedizione espresso in KG
origine*
String
Nazione origine della merce sigla iso 2 char
merce*
String
Descrizione generica della merce spedita
ddt_num
String
Riferimento numerico della spedizione, se non definito Gsped ne crea uno automaticamente
ddt_alpha
String
Riferimento alfanumerico della spedizione, se non definito Gsped ne crea uno automaticamente
client_id*
Int
ID cliente fornito da Gsped
servizio*
Int
sender_cap
String
Zipcode del mittente
sender_city
String
Località mittente
sender_addr
String
Indirizzo mittente
sender_contact
String
Nome contatto mittente
sender_name
String
Nome mittente
rcpt_contact*
String
Nome contatto destinatario
rcpt_name*
String
Nome destinatario
sender_email
String
Email mittente
sender_phone
String
Telefono mittente
sender_country_code
String
Nazione mittente sigla iso 2 char
rcpt_prov*
String
Provincia/Stato desinatario sigla iso 2 char
rcpt_cap*
String
Zipcode destinatario
rcpt_city*
String
Località destinatario
rcpt_addr*
String
Indirizzo destinatario
sender_prov
String
Provincia/Stato mittente siga iso 2 char
rcpt_phone*
String
Telefono destinatario
rcpt_email*
String
Email destinatario
rcpt_country_code*
String
Nazione destinatario sigla iso 2 char
note_sender
String
Note del mittente
valuta
Sigla valuta iso 4217
valore
Float
Valore importo assicurazione
dropshipping
String
Flag 1 per inviare lettera di vettura alla mail del mittente
al_sabato
String
Flag S|N per attivare servizio al sabato (solo per corrieri abilitati)
al_piano
String
Flag S|N per attivare servizio al piano (solo per corrieri abilitati)
fermo_deposito
String
Flag S|N per identificare una spedizione in fermo deposito
reso_contestuale
String
Flag S|N per attivare servizio EXCHANGE (solo per corrieri abilitati)
documenti
String
Flag 0|1 per identificare una spedizione di documenti
addebito_dogana
Int
Assegnazione oneri doganali. Valori ammessi : - 0 : Oneri doganali al destinatario - 1 : Oneri doganali al mittente - 2 : Oneri doganalia terzo
chi_paga
Int
Assegnazione costi spedizione : - 0 : Paga il mittente - 1 : Paga il destinatario
valore_doganale
Float
Indicazione del valore doganale
id_order_gelproximity
String
ID ordine sui sistemi di Gel Proximity per invio tracking
invoice_date
String
Data formato YYYY-MM-GG della data della fattura
invoice_number
String
Numero della fattura
invoiced_client_id
Int
DA VALORIZZARE SOLO PER LE ISTANZE RESELLER Da utilizzare per indicare a quale cliente del reseller abbinare la spedizione.
Snippets codice di esempio
Scelta del corriere più economico
Nel caso si desideri che Gsped esegua la scelta del corriere più economico in base ai propri listini (configurati su Gsped) bisogna impostare nella chiamata corriere = 0 e servizio = 0
Esempio payload :
Shipment - DELETE
Questo endpoint consente di cancellare spedizioni create in precedenza solo se non sono ancora state confermate.
Shipment DELETE
DELETE
https://api.gsped.it/[ISTANZA]/Shipment
Cancellazione di una spedizione sui sistemi Gsped e del corriere
Query Parameters
id*
String
ID univoco Gsped della spedizione
Headers
x-api-key*
String
Apikey fornita da Gsped
Snippets codice di esempio
Shipment - PATCH
Questo endpoint permette di modificare una spedizione senza bisogno di ricreare l'etichetta SOLO se la spedizione non è ancora stata confermata.
PATCH
https://api.gsped.it/[ISTANZA]/Shipment/[idSpedizione]
Recupera tutte le informazioni di una spedizione compre le etichette
Headers
x-api-key*
String
Apikey fornita da GSPED
Request Body
Snippets codice di esempio
Last updated
Was this helpful?