Vai al contenuto principale
DELETE
Annulla un ordine di spedizione. Chiama l’API del fornitore logistico per annullare l’ordine e aggiorna lo stato della spedizione a cancelled. Annullare una spedizione già in stato cancelled restituisce 200 con quella spedizione e il fornitore viene chiamato una sola volta. La risposta include Idempotent-Replayed: true così puoi distinguere una ripetizione dalla chiamata che ha eseguito l’operazione. Vedi Idempotenza.
Le spedizioni non possono essere annullate dopo il ritiro — in quel caso viene restituito 409 Conflict.
Un’etichetta di reso DHL non può essere annullata da sola; anche in questo caso viene restituito 409 Conflict. Annulla invece il pacco di andata. Annullare un pacco DHL di andata annulla anche le relative righe di ritorno pending. Ciascuna diventa cancelled con una voce RETURN_LEG_CANCELLED in status_updates. Vedi Etichette di reso. In una scatola con più kit, ogni kit ha la propria riga di andata e la propria etichetta di reso, anche quando la scatola viaggia con l’etichetta di un solo kit. Annullare la riga di andata di un kit annulla anche l’etichetta di reso di quel kit. Per annullare un pacco con kit a domicilio, ogni ordine di kit a domicilio collegato deve rientrare nel tuo contesto di accesso. In caso contrario la chiamata restituisce 403. Vedi Accesso.

Richiesta

Parametri di percorso

string
obbligatorio
ID di riferimento della spedizione (ad es. P2611194821).

Risposta

In caso di successo, l’API restituisce 200 OK con l’oggetto della spedizione annullata.
string
obbligatorio
Identificativo di riferimento della spedizione.
string
obbligatorio
Stato del ciclo di vita della spedizione. Sarà cancelled dopo un annullamento riuscito.
string
obbligatorio
Fornitore logistico. Uno tra go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups o dhl_express. Un pacco con kit a domicilio è dhl_parcel, oppure dhl_warenpost quando viene spedito all’estero come Warenpost International.
string
Numero di tracciamento esterno del fornitore logistico. Può essere null.
string
Descrizione in testo libero del contenuto del pacco, come fornita alla creazione. Può essere null.
string
obbligatorio
Chi ha stampato l’etichetta: aniva o external. Solo le spedizioni aniva accettano questa chiamata.
string
Riferimento dell’altro pacco in una spedizione a due pacchi. null per un pacco di sola andata.
object
Indirizzo di ritiro. Può essere null.
object
Indirizzo di consegna. Stessa struttura di origin. Può essere null.
object
Fascia di ritiro programmata. Può essere null.
string
Note facoltative. Può essere null.
object[]
obbligatorio
Eventi cronologici del ciclo di vita dal fornitore logistico (dal più vecchio al più recente). Ogni voce contiene state, code, detail_code, status, description, location e time. Consulta Ottieni spedizione per ogni campo. Array vuoto se non sono ancora stati rilevati eventi.
ShipmentAppointmentLink[]
obbligatorio
Appuntamenti collegati a questa spedizione prima dell’annullamento. Ogni voce è { id, added_at }; confronta ogni id con Ottieni appuntamento. Sono elencati solo gli appuntamenti nel tuo contesto di accesso.
ShipmentHomeKitOrderLink[]
obbligatorio
Ordini di kit a domicilio collegati a questa spedizione, dal collegamento più vecchio al più recente, nello stesso formato { id, added_at }. Sono elencati solo gli ordini nel tuo contesto di accesso. Array vuoto per i pacchi degli studi medici.
string
Quando la spedizione è stata sincronizzata per l’ultima volta con il corriere, come istante UTC. null fino alla prima sincronizzazione.
string
obbligatorio
Timestamp di creazione (ISO 8601).
string
Timestamp dell’ultimo aggiornamento (ISO 8601). Può essere null.

Risposte di errore