Saltar al contenido principal
GET
Obtén los envíos accesibles para tu clave de API, del más reciente al más antiguo. Todos los paquetes están en esta misma lista: una recogida por mensajería en una clínica, el kit de camino a un paciente con kit de prueba en casa y la muestra de vuelta. Filtra por un elemento padre con appointment_id o home_kit_order_id. Requiere el scope shipments_view o shipments_manage. La respuesta procede de nuestra base de datos y nunca llama al transportista. Una sincronización en segundo plano actualiza cada envío (cada 10 minutos para GO! y cada hora para DHL), y synced_at en cada fila te indica cuándo se consultó al transportista por última vez.

Solicitud

Parámetros de consulta

string
Solo los envíos vinculados a esta cita (UUID). 404 cuando la cita no existe, 403 cuando está fuera de tu contexto de acceso.
string
Solo los envíos vinculados a este pedido de kit de prueba en casa (UUID). Normalmente se devuelven dos filas: el kit de camino al paciente y la muestra de vuelta al laboratorio (su destination es el laboratorio). Mismas reglas de 404 / 403 que para appointment_id.
string
Solo los envíos en este estado. Uno de pending, in_transit, delivered, fault, cancelled.
integer
Número máximo de envíos que se devuelven. Por defecto 100, máximo 500.
integer
Número de envíos que se omiten. Por defecto 0. El orden es estable (created_at descendente y luego referencia), por lo que las páginas no se solapan.

Respuesta

En caso de éxito, la API devuelve 200 OK con un array de objetos de envío.
string
requerido
Identificador de referencia del envío.
string
requerido
Estado del ciclo de vida del envío. Uno de pending, in_transit, delivered, fault o cancelled.
string
requerido
Proveedor logístico. Puede ser go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups o dhl_express. Un paquete de kit a domicilio es dhl_parcel, o dhl_warenpost cuando se envía al extranjero como Warenpost International.
string
Número de seguimiento externo del proveedor logístico. Puede ser null.
string
Descripción en texto libre del contenido del paquete, tal como se indicó al crearlo (p. ej., "Medizinisch freigestellte Probe", "Home test kit"). Solo informativo: si un paquete va dirigido a un laboratorio se consulta en destination, y su envío asociado en paired_with. Puede ser null.
string
requerido
Quién imprimió la etiqueta: aniva o external. Solo los envíos aniva admiten Actualizar y Cancelar; un paquete external tiene seguimiento, pero devuelve 501 en ambos casos.
string
Referencia del otro paquete de una expedición de dos paquetes: el paquete que llevaba una etiqueta de devolución y el paquete que vuelve con esa etiqueta. Definido en ambos. null para un paquete de solo ida.
object
Dirección de recogida. Puede ser null.
object
Dirección de entrega. Misma estructura que origin. Puede ser null.
object
Franja de recogida programada. Puede ser null.
string
Notas opcionales. Puede ser null.
object[]
requerido
Eventos cronológicos del ciclo de vida procedentes del proveedor logístico (del más antiguo al más reciente). Array vacío si el proveedor aún no ha comunicado ningún evento. Úsalo para la interfaz por evento, auditorías y las señales más detalladas del transportista; básate en status para el estado actual canónico.
ShipmentAppointmentLink[]
requerido
Citas vinculadas a este envío, empezando por el vínculo más antiguo. Cada entrada es { id, added_at }; consulta cada id en Obtener cita para obtener los datos completos de la cita. Array vacío cuando no hay citas vinculadas. Solo se muestran las citas dentro de tu contexto de acceso.
ShipmentHomeKitOrderLink[]
requerido
Pedidos de kit de prueba en casa vinculados a este envío, empezando por el vínculo más antiguo, con la misma estructura { id, added_at }. Consulta cada id en Obtener pedido de kit de prueba en casa. Array vacío para paquetes de clínicas. Solo se muestran los pedidos dentro de tu contexto de acceso. Consulta Acceso.
string
Cuándo se contrastó por última vez el envío con su transportista, como instante UTC. Las lecturas nunca llaman al transportista —una sincronización en segundo plano mantiene actualizados los envíos—, así que esto indica la antigüedad de la respuesta. null hasta la primera sincronización.
string
requerido
Marca de tiempo de creación (ISO 8601).
string
Marca de tiempo de la última actualización (ISO 8601). Puede ser null.

Llamadas repetidas

Aniva almacena la respuesta de este endpoint durante 5 minutos para cada clave de API. Una llamada repetida dentro de este plazo obtiene la respuesta almacenada. Las cabeceras Cache-Status y Age indican que la respuesta está almacenada y cuál es su antigüedad. Para enterarte de un cambio al instante, suscríbete a los eventos de webhook shipment.created y shipment.updated. Consulta Lecturas repetidas.

Respuestas de error