Passer au contenu principal
POST
Crée une commande d’envoi depuis le site d’origine indiqué. Tu indiques le laboratoire de destination avec destination_lab. L’envoi est expédié à l’adresse de livraison enregistrée pour ce laboratoire. Nécessite le scope shipments_manage. Envoie un en-tête facultatif Idempotency-Key pour pouvoir relancer cette création sans risque — répéter la même clé renvoie la réponse d’origine au lieu d’en créer un second. Voir Idempotence.

Requête

Paramètres du corps

string
requis
UUID du site de test d’origine. Le site doit être actif et faire partie du contexte d’accès de ta clé API. Utilise Lister les sites pour trouver les ID de site disponibles.
string
requis
Laboratoire de destination. Valeur parmi zotzklimas, labclinic, nordicgroup, biomes, imd ou quade. L’envoi est expédié à l’adresse de livraison enregistrée pour ce laboratoire. Un laboratoire sans adresse de livraison enregistrée renvoie 400.
string
UUID facultatif d’un rendez-vous auquel associer cet envoi dès sa création. Le rendez-vous doit faire partie du contexte d’accès de ta clé API. Le lien apparaît directement comme une entrée dans le tableau appointments de l’envoi, et inversement comme une entrée dans le tableau shipments du rendez-vous. Pour associer d’autres rendez-vous après la création, ou retirer le lien initial, utilise Associer des rendez-vous à un envoi et Dissocier des rendez-vous d’un envoi.
string
requis
Date de collecte au format YYYY-MM-DD (par ex. 2026-04-15), interprétée dans le fuseau horaire du site d’origine. Doit être un jour ouvré (lundi–vendredi), aujourd’hui ou dans le futur. Les collectes le jour même ne sont plus disponibles après 16:00 Europe/Berlin.
string
requis
Heure de collecte au plus tôt au format HH:MM (par ex. 09:00), interprétée comme l’heure locale dans le fuseau horaire du site d’origine. Doit être comprise entre 09:00 et 19:00.
string
requis
Heure de collecte au plus tard au format HH:MM (par ex. 12:00), interprétée comme l’heure locale dans le fuseau horaire du site d’origine. Doit être comprise entre 09:00 et 19:00. Le créneau (pickup_time_till - pickup_time_from) doit durer au moins 2 heures.
integer
défaut:"1"
Nombre de colis. Valeur par défaut : 1.
number
défaut:"0.5"
Poids en kg. Valeur par défaut : 0.5.
string
Instructions pour le coursier lors de la collecte (remarques de l’expéditeur). En cas d’omission, les remarques enregistrées sur l’adresse de collecte sont utilisées (ou aucune si l’adresse n’en comporte pas). 128 caractères maximum.
string
Description libre du contenu du colis, affichée au coursier et renvoyée dans contents. 40 caractères maximum (par ex. Medizinisch freigestellte Probe).
string
Notes internes facultatives. 128 caractères maximum.

Réponse

En cas de succès, l’API renvoie 201 Created avec le nouvel envoi.
string
requis
Identifiant de référence de l’envoi (par ex. P2604151234).
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 que fournie à la création. Peut être null.
string
requis
Qui a imprimé l’étiquette : aniva ou external. Un envoi que tu crées a la valeur aniva.
string
Référence de l’autre colis d’un envoi en deux colis. 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 provenant du prestataire logistique (du plus ancien au plus récent). Chaque entrée contient state, code, detail_code, status, description, location et time. Voir Récupérer un envoi pour chaque champ. Tableau vide immédiatement après la création. La synchronisation en arrière-plan ajoute les événements à mesure que le prestataire les signale.
ShipmentAppointmentLink[]
requis
Rendez-vous associé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 Récupérer un rendez-vous. Contient le rendez-vous transmis via appointment_id (le cas échéant) immédiatement après la création.
ShipmentHomeKitOrderLink[]
requis
Commandes de kit à domicile associées à cet envoi, au même format { id, added_at }. Tableau vide pour un envoi que tu crées.
string
Date et heure de la dernière synchronisation de l’envoi avec son transporteur, en temps UTC. 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.

Réponses d’erreur