Passer au contenu principal
PATCH
Mets à jour les détails de l’envoi tels que l’horaire d’enlèvement, le nombre de colis ou les notes. Si un champ lié à la logistique change (date ou heure d’enlèvement, nombre de colis ou poids), la commande logistique existante est annulée et une nouvelle est créée automatiquement. Les champs que tu omets sont conservés tels quels depuis l’envoi existant. Les champs d’horaire mis à jour sont validés selon les règles d’horaires d’enlèvement.
Les envois ne peuvent pas être modifiés après l’enlèvement. Tenter de mettre à jour un envoi déjà enlevé renvoie 409 Conflict.
Un colis de kit à domicile a déjà son étiquette imprimée, donc seul le champ notes peut changer. Un nouveau créneau d’enlèvement ou un nouveau poids sur un colis de kit à domicile renvoie 409 Conflict ; annule-le et crée plutôt un nouvel envoi. Pour mettre à jour un colis de kit à domicile, chaque commande de kit à domicile liée doit faire partie de ton contexte d’accès. Sinon, l’appel renvoie 403. Voir Accès.

Requête

Paramètres de chemin

string
requis
ID de référence de l’envoi (par ex. P2611194821).

Paramètres du corps

Tous les paramètres du corps sont facultatifs — inclus uniquement les champs que tu veux modifier.
string
Nouvelle date d’enlèvement au format YYYY-MM-DD, interprétée dans le fuseau horaire du lieu d’origine.
string
Nouvelle heure d’enlèvement au plus tôt au format HH:MM, interprétée en heure locale du lieu d’origine.
string
Nouvelle heure d’enlèvement au plus tard au format HH:MM, interprétée en heure locale du lieu d’origine.
integer
Nouveau nombre de colis.
number
Nouveau poids en kg.
string
Nouvelles notes ou remarques. 128 caractères maximum.

Réponse

En cas de succès, l’API renvoie 200 OK avec l’envoi mis à jour.
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 que fournie à la création. Peut être null.
string
requis
Qui a imprimé l’étiquette : aniva ou external. Seuls les envois aniva acceptent cet appel.
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 si aucun événement n’a encore été observé.
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. Seuls les rendez-vous de ton contexte d’accès sont listés.
ShipmentHomeKitOrderLink[]
requis
Commandes de kit à domicile associées à cet envoi, du lien le plus ancien au plus récent, au même format { id, added_at }. Seules les commandes de ton contexte d’accès sont listées. Tableau vide pour les colis de cabinet.
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