Vai al contenuto principale
GET
Recupera le spedizioni accessibili alla tua chiave API, dalla più recente. Ogni pacco è in questo unico elenco: un ritiro tramite corriere da uno studio medico, il kit in viaggio verso un paziente con kit domiciliare e il campione in ritorno. Filtra per un singolo elemento principale con appointment_id o home_kit_order_id. Richiede lo scope shipments_view o shipments_manage. La risposta proviene dal nostro database e non chiama mai il corriere. Una sincronizzazione in background aggiorna ogni spedizione (ogni 10 minuti per GO!, ogni ora per DHL) e synced_at in ogni riga ti indica quando il corriere è stato interrogato l’ultima volta.

Richiesta

Parametri di query

string
Solo spedizioni collegate a questo appuntamento (UUID). 404 quando l’appuntamento non esiste, 403 quando è fuori dal tuo contesto di accesso.
string
Solo spedizioni collegate a questo ordine di kit domiciliare (UUID). Di norma vengono restituite due righe: il kit in viaggio verso il paziente e il campione di ritorno al laboratorio (il suo destination è il laboratorio). Stesse regole 404 / 403 di appointment_id.
string
Solo spedizioni in questo stato. Uno tra pending, in_transit, delivered, fault, cancelled.
integer
Numero massimo di spedizioni da restituire. Valore predefinito 100, massimo 500.
integer
Numero di spedizioni da saltare. Valore predefinito 0. L’ordinamento è stabile (created_at decrescente, poi riferimento), quindi le pagine non si sovrappongono.

Risposta

In caso di successo, l’API restituisce 200 OK con un array di oggetti spedizione.
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 indicata alla creazione (es. "Medizinisch freigestellte Probe", "Home test kit"). Solo a scopo informativo — per sapere se un pacco è diretto a un laboratorio si legge destination, e il pacco corrispondente da paired_with. Può essere null.
string
obbligatorio
Chi ha stampato l’etichetta: aniva o external. Solo le spedizioni aniva accettano Aggiorna e Annulla; un pacco external viene tracciato, ma restituisce 501 per entrambe le operazioni.
string
Riferimento dell’altro pacco di una spedizione di due pacchi: il pacco che conteneva un’etichetta di reso e il pacco che quell’etichetta riporta indietro. Impostato su entrambi. 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). Array vuoto se il fornitore non ha ancora segnalato eventi. Usalo per la UI per evento, l’audit e i segnali più dettagliati del corriere; affidati a status per lo stato attuale canonico.
ShipmentAppointmentLink[]
obbligatorio
Appuntamenti collegati a questa spedizione, dal collegamento più vecchio. Ogni voce è { id, added_at }; confronta ogni id con Ottieni appuntamento per il payload completo dell’appuntamento. Array vuoto se non ci sono appuntamenti collegati. Vengono elencati solo gli appuntamenti nel tuo contesto di accesso.
ShipmentHomeKitOrderLink[]
obbligatorio
Ordini di kit domiciliari collegati a questa spedizione, dal collegamento più vecchio, nella stessa struttura { id, added_at }. Confronta ogni id con Ottieni ordine kit domiciliare. Array vuoto per i pacchi degli studi medici. Vengono elencati solo gli ordini nel tuo contesto di accesso. Vedi Accesso.
string
Quando la spedizione è stata sincronizzata l’ultima volta con il corriere, come istante UTC. Le letture non chiamano mai il corriere — una sincronizzazione in background mantiene aggiornate le spedizioni — quindi questo indica quanto è vecchia la risposta. null fino alla prima sincronizzazione.
string
obbligatorio
Timestamp di creazione (ISO 8601).
string
Timestamp dell’ultimo aggiornamento (ISO 8601). Può essere null.

Chiamate ripetute

Aniva salva la risposta di questo endpoint per 5 minuti per ogni chiave API. Una chiamata ripetuta in questo intervallo riceve la risposta salvata. Gli header Cache-Status e Age indicano che la risposta è salvata e da quanto tempo. Per sapere subito di una modifica, iscriviti agli eventi webhook shipment.created e shipment.updated. Vedi Letture ripetute.

Risposte di errore