Passer au contenu principal
GET
Récupère les envois accessibles à ta clé API, du plus récent au plus ancien. Chaque colis figure dans cette seule liste : une collecte par coursier depuis un cabinet, le kit en route vers un patient avec kit à domicile, et l’échantillon sur le chemin du retour. Filtre sur un seul parent avec appointment_id ou home_kit_order_id. Nécessite le scope shipments_view ou shipments_manage. La réponse provient de notre base de données et n’appelle jamais le transporteur. Une synchronisation en arrière-plan actualise chaque envoi (toutes les 10 minutes pour GO!, toutes les heures pour DHL) et synced_at sur chaque ligne t’indique quand le transporteur a été interrogé pour la dernière fois.

Requête

Paramètres de requête

string
Uniquement les envois liés à ce rendez-vous (UUID). 404 quand le rendez-vous n’existe pas, 403 quand il est en dehors de ton contexte d’accès.
string
Uniquement les envois liés à cette commande de kit à domicile (UUID). En principe, deux lignes sont renvoyées — le kit en route vers le patient et l’échantillon de retour au laboratoire (sa destination est le laboratoire). Mêmes règles 404 / 403 que pour appointment_id.
string
Uniquement les envois dans ce statut. Une valeur parmi pending, in_transit, delivered, fault, cancelled.
integer
Nombre maximal d’envois à renvoyer. Par défaut 100, maximum 500.
integer
Nombre d’envois à ignorer. Par défaut 0. Le tri est stable (created_at décroissant, puis référence), de sorte que les pages ne se chevauchent pas.

Réponse

En cas de succès, l’API renvoie 200 OK avec un tableau d’objets envoi.
string
requis
Identifiant de référence de l’envoi.
string
requis
Statut du cycle de vie de l’envoi. Valeur parmi pending, in_transit, delivered, fault ou cancelled.
string
requis
Prestataire logistique. L’une des valeurs go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups ou dhl_express. Un colis de kit à domicile utilise dhl_parcel, ou dhl_warenpost lorsqu’il part à l’étranger en Warenpost International.
string
Numéro de suivi externe du prestataire logistique. Peut être null.
string
Description libre du contenu du colis, telle qu’indiquée à la création (par ex. "Medizinisch freigestellte Probe", "Home test kit"). À titre informatif uniquement — pour savoir si un colis est destiné à un laboratoire, consulte destination, et pour son pendant, consulte paired_with. Peut être null.
string
requis
Qui a imprimé l’étiquette : aniva ou external. Seuls les envois aniva acceptent Mettre à jour et Annuler ; un colis external est suivi mais renvoie 501 pour les deux.
string
Référence de l’autre colis d’une expédition de deux colis — le colis qui contenait une étiquette de retour et le colis que cette étiquette renvoie. Défini sur les deux. null pour un colis aller simple.
object
Adresse d’enlèvement. Peut être null.
object
Adresse de livraison. Même structure que origin. Peut être null.
object
Créneau de collecte programmé. Peut être null.
string
Notes facultatives. Peut être null.
object[]
requis
Événements chronologiques du cycle de vie fournis par le prestataire logistique (du plus ancien au plus récent). Tableau vide si le prestataire n’a encore signalé aucun événement. Utilise ce champ pour l’affichage par événement, l’audit et les signaux fins du transporteur ; appuie-toi sur status pour l’état actuel de référence.
ShipmentAppointmentLink[]
requis
Rendez-vous liés à cet envoi, du lien le plus ancien au plus récent. Chaque entrée a la forme { id, added_at } ; recoupe chaque id avec Obtenir un rendez-vous pour obtenir l’objet complet du rendez-vous. Tableau vide lorsqu’aucun rendez-vous n’est lié. Seuls les rendez-vous de ton contexte d’accès sont listés.
ShipmentHomeKitOrderLink[]
requis
Commandes de kit à domicile liées à cet envoi, du lien le plus ancien au plus récent, au même format { id, added_at }. Recoupe chaque id avec Obtenir une commande de kit à domicile. Tableau vide pour les colis de cabinet. Seules les commandes de ton contexte d’accès sont listées. Voir Accès.
string
Moment de la dernière synchronisation de l’envoi avec son transporteur, en UTC. Les lectures n’appellent jamais le transporteur — une synchronisation en arrière-plan garde les envois à jour — ce champ indique donc l’ancienneté de la réponse. null jusqu’à la première synchronisation.
string
requis
Horodatage de création (ISO 8601).
string
Horodatage de dernière mise à jour (ISO 8601). Peut être null.

Appels répétés

Aniva conserve la réponse de ce point de terminaison pendant 5 minutes pour chaque clé API. Un appel répété pendant ce délai reçoit la réponse conservée. Les en-têtes Cache-Status et Age indiquent que la réponse est conservée et depuis combien de temps. Pour être informé d’un changement immédiatement, abonne-toi aux événements webhook shipment.created et shipment.updated. Voir Lectures répétées.

Réponses d’erreur