Programme pour développeurs

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

Ressources

Expédition sans convention

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

Demander le remboursement d'un envoi sans convention – Module REST

Résumé

Nom :	Demander le remboursement d'un envoi sans convention
Raison pour utiliser le service :	Demander le remboursement d'un envoi ou d'une étiquette créé par erreur. Vous pouvez seulement demander un remboursement pour un envoi qui n'a pas encore été expédié et pour lequel aucune activité de balayage n'est associée à l'étiquette. 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.
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 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 :	Créer l'envoi sans convention, Obtenir les envois sans convention ou Obtenir l'envoi sans convention
Prochaine demande de service habituelle :	Aucune
Historique des versions :	Notes de mise à jour

Demander le remboursement d'un envoi sans convention – 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 créer un envoi sans convention, obtenir l'envoi sans convention ou Obtenir les envois sans convention lorsque rel="refund".

En-têtes HTTP

Variable des en-têtes HTTP	Valeur
Accept	application/vnd.cpc.ncshipment-v4+xml (Remarque : / à la place de la valeur de l'en-tête affichera un message d'erreur)
Content-Type	application/vnd.cpc.ncshipment-v4+xml (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

<?xml version="1.0" encoding="utf-8"?>
<non-contract-shipment-refund-request xmlns="http://www.canadapost.ca/ws/ncshipment-v4">
xxx
</non-contract-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 sans convention. Pour obtenir la structure hiérarchique des entrées, consultez le diagramme XML.

Demander le remboursement d'un envoi sans convention – Éléments de la demande
Nom de l'élément	Type	Requis/Optionnel	Description
non-contract-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 sans convention – 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 sans convention – Éléments de la réponse
Nom de l'élément	Type	Description
non-contract-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 sans convention – 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
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 sans convention


  
    
<non-contract-shipment-refund-request xmlns="http://www.canadapost.ca/ws/ncshipment-v4">

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

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


  
    
<non-contract-shipment-refund-request-info>

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

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

Ouvrir unesession