Expédition avec convention

Exemples de codes pour l'expédition avec convention : Java (.zip) | PHP (.zip) | C# (.zip)

Annuler l'envoi – Module SOAP

Résumé

Nom : Annuler l'envoi
Raison pour utiliser le service :

Pour supprimer un envoi précis avant la transmission. 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.

Nota : À titre de solution de rechange à l'annulation d'un envoi, vous pouvez exclure votre envoi de la demande de transmission afin qu'il demeure actif aux fins d'inclusion dans une demande de transmission subséquente.

Données d'entrée :

Shipment-id; mailed-by; locale (optionnel)

Données de sortie : Aucune (élément de niveau supérieur vide)
Exemple d'erreur : Numéro d'identification invalide ou expiré pour l'envoi
Historique des versions :

Notes de mise à jour

Annuler l'envoi – Résumé du service

Annuler l'envoi – Résumé du service

Détails sur la demande

WSDL : shipment.wsdl
Point final (Conception) : https://ct.soa-gw.canadapost.ca/rs/soap/shipment/v8
Point final (Production) : https://soa-gw.canadapost.ca/rs/soap/shipment/v8
Espace de nommage : http://www.canadapost.ca/ws/soap/shipment/v8
Opération : VoidShipment

Corps – SOAP

La présente section décrit les éléments XML d'entrée pour ce service. Pour obtenir la structure hiérarchique, consultez le diagramme XML.

Annuler l'envoi – Éléments de la demande
Nom de l'élément Type Requis/Optionnel Description

void-shipment-request

complexe

requis

Structure XML générale pour les données d'entrée de la demande.

mailed-by

simple

requis

(1 à 10 caractères numériques)

Il s'agit du numéro de client à 10 chiffres du client « Expédié par ».

Si le numéro fourni compte moins de 10 chiffres, le système ajoutera des zéros au début.

mobo

simple

optionnel

(1 à 10 caractères numériques)

Il s'agit du numéro de client à 10 chiffres du client « Expédié au nom de ».

S'il manque cet élément, le numéro du client « Expédié par » s'affichera par défaut.

Si le numéro fourni compte moins de 10 chiffres, le système ajoutera des zéros au début.

locale

simple

optionnel

Indique votre langue de préférence pour recevoir les messages d'erreur.

EN = Anglais
FR = Français

Si aucune valeur n'est fournie, la langue par défaut est « Anglais ».

manifest-id

simple

requis sous condition

(Chaîne de caractères – Jusqu'à 32 caractères)

Numéro d'identification représentant l'envoi existant pour lequel les renseignements sont demandés.

Nota : Il faut récupérer le numéro d'identification de l'envoi fourni dans le cadre des demandes de service précédentes « Créer l'envoi » et « Obtenir l'envoi ». Les données de sortie de ces services comprendront un numéro d'identification pour l'envoi.

Demande – Diagramme XML

Annuler l'envoi – Structure de la demande XML

Annuler l'envoi – Structure de la demande XML

Détails de la réponse

Réponse – Éléments

Le tableau suivant décrit les éléments XML figurant dans la réponse à la demande d'obtention du service. Pour obtenir la hiérarchie de la réponse, consultez le diagramme XML.

Annuler l'envoi – Éléments de la réponse
Nom de l'élément Type Description

void-shipment-response

Complexe

Niveau supérieur de la structure XML.

void-shipment-success

Simple

Vrai | Faux

Simple indicateur signalant l'exécution réussie de l'annulation de l'envoi.

Réponse – Diagramme XML

Annuler l'envoi – Structure de la réponse XML

Annuler l'envoi – Structure de la réponse XML

Réponse – Réponses d'erreur possibles

La réponse à des conditions d'erreur pour ce service en ligne respecte l'approche standard SOAP liée à la réponse d'erreur, laquelle est utilisée pour tous les services en ligne de Postes Canada. Pour obtenir de plus amples renseignements, consultez les Principes de base liés au module SOAP pour les services en ligne de Postes Canada.

Les messages d'erreur possibles pour ce service sont les suivants :

Code HTTP Code Message Signification

200

404

Introuvable

La ressource est introuvable. Cela signifie que le numéro d'identification de l'envoi est inexact, que l'envoi a déjà été annulé ou qu'il a déjà été transmis.

500

Serveur

/rs/soap/shipment: cvc-simple-type 1: element shipment-id of type

{http://www.canadapost.ca/ws/soap/shipment/v8}ShipmentIDType pourrait ne pas être vide.

Anomalie – Module SOAP : Aucun numéro d'identification de l'envoi n'a été précisé.

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 XML selon le module SOAP – Annuler l'envoi

<void-shipment-request>
<mailed-by>1111111</mailed-by>
<locale>EN</locale>
<shipment-id>340531309186521749</shipment-id>
</void-shipment-request>

Exemple de réponse XML selon le module SOAP – Annuler l'envoi

<void-shipment-response>
<void-shipment-success>true</void-shipment-success>
</void-shipment-response>