Programme pour développeurs

Prêt à rejoindre le Programme pour développeurs? Inscrivez-vous GRATUITE

Ressources

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 REST

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

Détails sur la demande

Structure de la demande pour Demander le remboursement d'un envoi

Point final

Il faut utiliser le lien associé à une demande de service précédente pour obtenir l'envoi ou les envois lorsque rel="refund".

En-têtes HTTP

Variable des en-têtes HTTP	Valeur
Accept	application/vnd.cpc.shipment-v8+xml (Note: / in place of the header value will return an error)
Content-Type	application/vnd.cpc.shipment-v8+xml (Note: / in place of the header value will return an error)
Authorization	Basic {Base64 encoding of userid:password}
Accept-language	en-CA or fr-CA

Corps du message

<?xml version="1.0" encoding="utf-8"?>
<shipment-refund-request xmlns=”http://www.canadapost.ca/ws/shipment-v8”>
xxx
</shipment-refund-request>

Éléments de la demande

Le tableau ci-dessous décrit les éléments XML d'entrée pour les demandes de remboursement d'un envoi. Pour obtenir la structure hiérarchique des entrées, consultez le diagramme XML.

Demander le remboursement d'un envoi – Éléments de la demande
Nom de l'élément	Type	Requis/Optionnel	Description
shipment-refund-request	Complexe	Requis	Structure XML générale pour les données d'entrée de la demande
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

Détails de la réponse

Réponse – Éléments

Le tableau ci-dessous décrit les champs XML dans la réponse. Pour obtenir la hiérarchie de la réponse, consultez le diagramme XML.

Demander le remboursement d'un envoi – Éléments de la réponse
Nom de l'élément	Type	Description
shipment-refund-request-info	Complexe	Niveau supérieur de la structure XML
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

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é.
7296	La demande n’a pu être complétée. Vous pouvez essayer de nouveau plus tard.

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 REST – Demander le remboursement d'un envoi


  
    
<shipment-refund-request xmlns="http://www.canadapost.ca/ws/shipment-v8">

      <email>name@example.ca</email>
      
    </shipment-refund-request>

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


  
    
<shipment-refund-request-info">

      <service-ticket-date>2015-01-28</service-ticket-date>

      <service-ticket-id>GT12345678RT</service-ticket-id>
      
    </shipment-refund-request-info>

Ouvrir unesession