Passer au contenu principal
DELETE
Annule une commande d’envoi. Cet appel contacte l’API du prestataire logistique pour annuler la commande et passe le statut de l’envoi à cancelled. Annuler un envoi déjà cancelled renvoie 200 avec cet envoi, et le prestataire n’est appelé qu’une seule fois. La réponse inclut Idempotent-Replayed: true pour que tu puisses distinguer une répétition de l’appel qui a effectué l’action. Voir Idempotence.
Les envois ne peuvent pas être annulés après l’enlèvement — cela renvoie 409 Conflict.
Une étiquette retour DHL ne peut pas être annulée seule ; cela renvoie aussi 409 Conflict. Annule plutôt le colis aller. Annuler un colis aller DHL annule également ses lignes de trajet retour pending. Chacune passe à cancelled avec une entrée RETURN_LEG_CANCELLED dans status_updates. Voir Étiquettes retour. Dans un carton contenant plusieurs kits, chaque kit a sa propre ligne aller et sa propre étiquette retour, même lorsque le carton voyage avec l’étiquette d’un seul kit. Annuler la ligne aller d’un kit annule aussi l’étiquette retour de ce kit. Pour annuler un colis de kit à domicile, chaque commande de kit à domicile liée doit se trouver dans 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).

Réponse

En cas de succès, l’API renvoie 200 OK avec l’objet de l’envoi annulé.
string
requis
Identifiant de référence de l’envoi.
string
requis
Statut du cycle de vie de l’envoi. Sera cancelled après une annulation réussie.
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 qui étaient associés à cet envoi avant l’annulation. Chaque entrée a la forme { id, added_at } ; recoupe chaque id avec Récupérer 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