Spedizioni
In questa sezione viene illustrato come creare e gestire ordini di spedizione sulla piattaforma.
Gli ordini di spedizione su GEL Proximity sono spedizioni che hanno come punto di partenza un magazzino del Merchant e come punto di destinazione un Punto di Ritiro appartenente ad una Rete o al Merchant stesso.
Per utilizzare le API presenti in questa guida è necessario essere autenticati alla piattaforma. Per maggiori informazioni consultare la sezione Autenticazione.
Permette di aggiornare lo stato del tracking di un ordine di spedizione.
Endpoint | gel-api-server/api/network/shipment/updateTracking |
Metodo | POST |
Nome | Tipo | Obbl. | Default | Descrizione |
---|---|---|---|---|
shipmentCode |
string |
Si | – | Codice GEL dell’ordine di spedizione |
statusCode |
ShipmentStatusCode |
Si | – | Codice GEL dello stato |
statusDescription |
string |
Si | – | Descrizione del cambio di stato |
lastUpdateDate |
string |
No | – | Data di aggiornamento dello stato in formato dd/MM/yyyy |
lastUpdateTime |
string |
No | – | Data di aggiornamento dello stato in formato hh:mm |
networkStatusCode |
string |
No | – | Codice di stato della Rete |
networkStatusReason |
string |
No | – | Descrizione di stato della Rete |
ShipmentStatusCode
Chiave | Valore |
---|---|
ST_0001 |
Ricevute istruzioni |
ST_0002 |
In gestione al magazzino |
ST_0003 |
In transito |
ST_0004 |
Consegnato al Point |
ST_0005 |
Consegna annullata |
ST_0006 |
Errore |
ST_0007 |
Ritirato dal cliente |
ST_0008 |
Consegna effettuata |
{
{
"shipmentCode": "SHP_2022019642",
"statusCode": "ST_0001",
"statusDescription": "Descrizione del cambio di stato"
},
}
Nome | Tipo | Descrizione |
---|---|---|
success |
boolean |
Esito della richiesta |
message |
string |
Messaggio di risposta |
{
"success": true,
"message": "Tracking aggiornato",
}
Ad ogni Rete è permesso impostare solamente determinati stati di tracking in base a diversi fattori, tra cui la tipologia di Merchant e l’appartenenza del Punto di Ritiro associato all’ordine di spedizione.
ShippingStatusCode | Permesso |
---|---|
ST_0001 |
No |
ST_0002 |
No |
ST_0003 |
No |
ST_0004 |
Si |
ST_0005 |
Si |
ST_0006 |
No |
ST_0007 |
Si |
ST_0008 |
No |