Expédition avec convention
Annuler l'envoi – Module REST
Résumé
Nom : | Annuler l'envoi |
---|---|
Raison pour utiliser le service : | Pour supprimer un envoi précis avant la transmission. À titre de solution de rechange, un envoi peut être exclu d'une demande de transmission et, par conséquent, il demeure actif aux fins d'inclusion dans une demande de transmission subséquente. La présentation de cette demande de service signifie que les étiquettes imprimées précédemment sont gâtées ou qu'elles ne seront pas utilisées. |
Données d'entrée : | Il faut utiliser un lien associé à une demande de service précédente lorsque rel=shipment. |
Données de sortie : | Aucune |
Exemple d'erreur : | 404 – Introuvable |
Demande de service précédente habituelle : | Créer l'envoi, Obtenir l'envoi ou Obtenir les envois |
Prochaine demande de service habituelle : | Aucune |
Historique des versions : |
Détails sur la demande
Structure de la demande pour annuler l'envoi
Point finalIl faut utiliser le lien associé à une demande de service précédente pour obtenir ou créer l'envoi lorsque rel="self".
OU
Il faut utiliser le lien associé à une demande de service précédente pour obtenir les envois lorsque rel="shipment".
(Consultez la section Points finaux fournis)
En-têtes HTTP
Variable des en-têtes HTTP |
Valeur |
---|---|
Accept |
À partir du media-type dans le lien original (Remarque : */* à la place de la valeur de l’en-tête affichera un message d’erreur) |
Authorization |
Basic {Encodage en base64 du code d'usager:mot de passe} |
Accept-language |
en-CA ou fr-CA |
Corps du message
Aucun
Éléments de la demande
Les données d'entrée XML ne sont pas nécessaires pour le service Annuler l'envoi.
Détails de la réponse
Réponse – Éléments
Le service Annuler l'envoi n'affiche pas les éléments XML. Le code de réponse HTTP positif est « 204 », ce qui signifie que l'opération a été effectuée avec succès et qu'il n'y a aucun contenu dans le corps XML.
Réponse – Réponses d'erreur possibles
Code | Message | Signification |
---|---|---|
404 |
La structure des messages est vide. |
La ressource n'a pas été trouvée alors l'ID de l'envoi est inexact ou l'envoi a déjà été annulé. |
8064 |
Un envoi peut seulement être annulé si son état est TRAITÉ ou IMPRIMÉ. |
L'envoi a déjà été transmis. Vous devez demander un remboursement. |
Exemples
Exemple de demande REST – Annuler l'envoi
DELETE https://XX/rs/345345/123456789/shipment/123456789012345678
Accept:application/vnd.cpc.shipment-v8+xml
Authorization:Basic 32j32h2jk23j-23==
Exemple de réponse XML – Annuler l'envoi
HTTP/1.1 204 OK
Content-type:text/html; charset=UTF-8
Le service Annuler l'envoi n'affiche pas les éléments XML.