Vai al contenuto principale
PATCH
Aggiorna i dettagli della spedizione come la pianificazione del ritiro, il numero di pacchi o le note. Se cambiano campi rilevanti per la logistica (data di ritiro, orario, numero di pacchi o peso), l’ordine logistico esistente viene annullato e ne viene creato automaticamente uno nuovo. I campi omessi vengono mantenuti dalla spedizione esistente. I campi di pianificazione aggiornati vengono convalidati in base alle regole di pianificazione del ritiro.
Le spedizioni non possono essere modificate dopo il ritiro. Il tentativo di aggiornare una spedizione già ritirata restituisce 409 Conflict.
Un pacco con kit domiciliare ha già l’etichetta stampata, quindi è possibile modificare solo notes. Una nuova fascia di ritiro o un nuovo peso su un pacco con kit domiciliare restituisce 409 Conflict; annullalo e crea invece una nuova spedizione. Per aggiornare un pacco con kit domiciliare, ogni ordine di kit domiciliare 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).

Parametri del body

Tutti i parametri del body sono facoltativi — includi solo i campi che vuoi modificare.
string
Nuova data di ritiro in formato YYYY-MM-DD, interpretata nel fuso orario della località di origine.
string
Nuovo orario minimo di ritiro in formato HH:MM, interpretato come ora locale nel fuso orario della località di origine.
string
Nuovo orario massimo di ritiro in formato HH:MM, interpretato come ora locale nel fuso orario della località di origine.
integer
Nuovo numero di pacchi.
number
Nuovo peso in kg.
string
Nuove note o osservazioni. Massimo 128 caratteri.

Risposta

In caso di successo, l’API restituisce 200 OK con la spedizione aggiornata.
string
obbligatorio
Identificativo di riferimento della spedizione.
string
obbligatorio
Stato del ciclo di vita della spedizione. Uno tra pending, in_transit, delivered, fault o cancelled.
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, dal collegamento più vecchio. Ogni voce è { id, added_at }; confronta ogni id con Ottieni appuntamento. Vengono 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