Saltar al contingut principal
GET
Recupera els enviaments accessibles per a la teva clau d’API, els més nous primer. Tots els paquets són en aquesta mateixa llista: una recollida per missatger d’una consulta, el kit de camí cap a un pacient amb kit de prova a casa i la mostra de tornada. Filtra per un únic element pare amb appointment_id o home_kit_order_id. Requereix l’àmbit shipments_view o shipments_manage. La resposta prové de la nostra base de dades i no crida mai el transportista. Una sincronització en segon pla actualitza cada enviament (cada 10 minuts per a GO!, cada hora per a DHL) i synced_at a cada fila t’indica quan s’ha consultat el transportista per última vegada.

Sol·licitud

Paràmetres de consulta

string
Només els enviaments vinculats a aquesta cita (UUID). 404 quan la cita no existeix, 403 quan és fora del teu context d’accés.
string
Només els enviaments vinculats a aquesta comanda de kit de prova a casa (UUID). Normalment es retornen dues files — el kit de camí cap al pacient i la mostra de tornada al laboratori (la seva destination és el laboratori). Mateixes regles 404 / 403 que appointment_id.
string
Només els enviaments en aquest estat. Un d’entre pending, in_transit, delivered, fault, cancelled.
integer
Nombre màxim d’enviaments a retornar. Per defecte 100, màxim 500.
integer
Nombre d’enviaments a ometre. Per defecte 0. L’ordenació és estable (created_at descendent, després referència), així que les pàgines no se solapen.

Resposta

Si té èxit, l’API retorna 200 OK amb una matriu d’objectes d’enviament.
string
requerit
Identificador de referència de l’enviament.
string
requerit
Estat del cicle de vida de l’enviament. Un de pending, in_transit, delivered, fault o cancelled.
string
requerit
Proveïdor logístic. Pot ser go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups o dhl_express. Un paquet de kit a domicili és dhl_parcel, o dhl_warenpost quan s’envia a l’estranger com a Warenpost International.
string
Número de seguiment extern del proveïdor logístic. Pot ser null.
string
Descripció en text lliure del contingut del paquet, tal com s’ha indicat en crear-lo (p. ex., "Medizinisch freigestellte Probe", "Home test kit"). Només informatiu — si un paquet va cap a un laboratori es llegeix a destination, i la seva contrapart a paired_with. Pot ser null.
string
requerit
Qui ha imprès l’etiqueta: aniva o external. Només els enviaments aniva accepten Actualitza i Cancel·la; un paquet external té seguiment, però retorna 501 en tots dos casos.
string
Referència de l’altre paquet d’un enviament de dos paquets — el paquet que portava una etiqueta de retorn i el paquet que torna amb aquesta etiqueta. Definit en tots dos. null per a un paquet d’un sol trajecte.
object
Adreça de recollida. Pot ser null.
object
Adreça de lliurament. Mateixa estructura que origin. Pot ser null.
object
Franja de recollida programada. Pot ser null.
string
Notes opcionals. Pot ser null.
object[]
requerit
Esdeveniments cronològics del cicle de vida del proveïdor logístic (el més antic primer). Matriu buida si el proveïdor encara no ha comunicat cap esdeveniment. Fes-ho servir per a la interfície per esdeveniment, l’auditoria i els senyals més precisos del transportista; basa’t en status per a l’estat actual canònic.
ShipmentAppointmentLink[]
requerit
Cites vinculades a aquest enviament, el vincle més antic primer. Cada entrada és { id, added_at }; creua cada id amb Obtén la cita per obtenir totes les dades de la cita. Matriu buida quan no hi ha cap cita vinculada. Només es llisten les cites del teu context d’accés.
ShipmentHomeKitOrderLink[]
requerit
Comandes de kit de prova a casa vinculades a aquest enviament, el vincle més antic primer, amb el mateix format { id, added_at }. Creua cada id amb Obtén la comanda de kit de prova a casa. Matriu buida per als paquets de consulta. Només es llisten les comandes del teu context d’accés. Consulta Accés.
string
Quan s’ha conciliat l’enviament per última vegada amb el seu transportista, com un instant UTC. Les lectures no criden mai el transportista — una sincronització en segon pla manté els enviaments actualitzats —, així que això indica l’antiguitat de la resposta. null fins a la primera sincronització.
string
requerit
Marca de temps de creació (ISO 8601).
string
Marca de temps de l’última actualització (ISO 8601). Pot ser null.

Crides repetides

Aniva desa la resposta d’aquest punt final durant 5 minuts per a cada clau d’API. Una crida repetida dins d’aquest període rep la resposta desada. Les capçaleres Cache-Status i Age indiquen que la resposta està desada i quina antiguitat té. Per assabentar-te d’un canvi a l’instant, subscriu-te als esdeveniments de webhook shipment.created i shipment.updated. Consulta Lectures repetides.

Respostes d’error