Expédition avec convention

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

Demander le remboursement d'un envoi – Module SOAP

Résumé

Nom :

Demander le remboursement d'un envoi

Raison pour utiliser le service :

Sert à demander le remboursement d'un envoi qui a été transmis. La présentation de cette demande de service signifie que l'étiquette d'expédition est abîmée et ne sera pas utilisée.

Veuillez noter qu'avant de procéder au remboursement, nous allons vérifier la validité de la demande en nous assurant, par exemple, que l'étiquette n'a pas été utilisée.

Si vous souhaitez annuler la totalité d'un manifeste, veuillez lire la façon de demander le remboursement d'un manifeste entier ou de plusieurs envois d'un manifeste.

Données d'entrée :

Votre courriel et le lien associé à une demande de service précédente pour obtenir l'envoi ou les envois lorsque rel="refund"

Données de sortie :

Numéro d'identification du billet de service

Exemple d'erreur :

Une demande de remboursement a déjà été soumise pour cet envoi. Il faut attendre quelques jours avant que le remboursement ne soit traité.

Demande de service précédente habituelle :

Obtenir les envois ou Obtenir l'envoi

Prochaine demande de service habituelle :

Aucune

Historique des versions :

Notes de mise à jour

Demander le remboursement d'un envoi – Résumé du service

Demander le remboursement d'un 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 : RequestRefundShipment

Corps du message

Éléments de la demande

La présente section décrit les éléments XML de la demande de remboursement d'un envoi. Pour obtenir la structure hiérarchique, consultez le diagramme XML.

Demander le remboursement d'un envoi – Éléments de la demande
Nom de l'élément Type Requis/Optionnel Description

request-shipment-refund-request

Complexe

Requis

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

mailed-by

Simple

Requis

(De un à dix 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 dix chiffres, le système ajoutera des zéros au début.

mobo

Simple

Optionnel

(De un à dix caractères numériques)
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 dix 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 saisie, la langue par défaut est l'anglais.

platform-id

Simple

Optionnel

Numéro de client de la plateforme. S'applique seulement aux plateformes de cybercommerce.

shipment-id

Simple

Optionnel

(Chaîne alphanumérique jusqu'à 32 lettres/chiffres)
Numéro d'identification de l'envoi pour lequel vous demandez un remboursement
Remarque : Il faut récupérer le numéro d'identification de l'envoi fourni dans le cadre des demandes de service précédentes pour obtenir l'envoi ou les envois. Les données de sortie de ces services comprendront un numéro d'identification pour l'envoi.

email

Simple

Requis

(Chaîne de caractères jusqu'à 60 caractères)
L'adresse électronique doit être valide. Par exemple, elle doit respecter le format suivant : (['_A-Za-z0-9\-\+])(\.['_A-Za-z0-9\-\+])@([A-Za-z0-9-])(\.[A-Za-z0-9-])(\.[A-Za-z]{2,})

Demande – Diagramme XML

Demander le remboursement d'un envoi – Structure de la demande XML
Demander le remboursement d'un envoi – Structure de la demande XML

Détails de la réponse

Réponse – Éléments

Le tableau ci-dessous décrit les éléments XML figurant dans la réponse à la demande de remboursement d'un envoi. Pour obtenir la hiérarchie de la réponse, consultez le diagramme XML.

Obtenir les détails de l'envoi – Éléments de la réponse
Nom de l'élément Type Description

request-shipment-refund-response

Complexe

Niveau supérieur de la structure XML

shipment-refund-request-info

Complexe

Structure contenant les données du billet de service

service-ticket-date

Simple

Date à laquelle la demande de remboursement a été soumise

service-ticket-id

Simple

Numéro d'identification du billet de service associé à votre demande de remboursement. Veuillez utiliser ce numéro dans toutes les communications que vous entretenez avec Postes Canada au sujet de cette demande de remboursement.

Remarque : Dans l'environnement (de développement) « Bac à sable », la même valeur d'essai (0123456789) est toujours retournée.

Réponse – Diagramme XML

Demander le remboursement d'un envoi – Structure de la réponse XML
Demander le remboursement d'un envoi – Structure de la réponse XML

Réponse – Réponses d'erreur possibles

Le code de retour http 404 (introuvable) s'affiche si le numéro d'identification de l'envoi est incorrect. Voici certaines autres réponses d'erreur possibles :

Code Description
7291 L'envoi n'a pas été transmis; vous devez annuler l'envoi.
7292 Une demande de remboursement a déjà été soumise pour cet envoi. Il faut attendre quelques jours avant que le remboursement ne soit traité.

Voir aussi les codes de statut HTTP et les messages d'erreur et les stratégies d'atténuation.

Exemples

Exemple de demande XML selon le module SOAP – Demander le remboursement d'un envoi

<request-shipment-refund-request>
<mailed-by>1111111</mailed-by>
<locale>EN</locale>
<shipment-id>340531309186521749</shipment-id> <email>name@example.ca</email>
</request-shipment-refund-request>

Exemple de réponse XML selon le module SOAP – Demander le remboursement d'un envoi

<request-shipment-refund-response>
<shipment-refund-request-info>
<service-ticket-date>2015-01-28</service-ticket-date>
<service-ticket-id>GT12345678RT</service-ticket-id>
</shipment-refund-request-info>
</request-shipment-refund-response>