Expédition avec convention

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

Obtenir le reçu de l'envoi – Module REST

Résumé

Nom :	Obtenir le reçu de l'envoi
Raison pour utiliser le service :	Utilisé pour obtenir les renseignements relatifs au règlement en format XML pour un envoi pour lequel un manifeste n'est pas requis et qui a été payé par carte de crédit ou par compte de fournisseur. Les données de la réponse peuvent être formatées pour imprimer un reçu.
Données d'entrée :	Utiliser le lien associé au service Créer l'envoi ou Obtenir l'envoi lorsque rel= "receipt"
Données de sortie :	Les détails sur l'autorisation de la carte de crédit ou par compte de fournisseur en format XML.
Exemple d'erreur :	N'a pu être trouvé (ce qui peut également se produire si l'envoi n'a pas été payé par carte de crédit.
Demande de service précédente habituelle :	Créer l'envoi ou Obtenir l'envoi
Prochaine demande de service habituelle :	Créer l'envoi (pour continuer à créer des envois)
Prochaine demande de service optionnelle :	Obtenir l'artefact ou Obtenir les détails de l'envoi (si ces services n'ont pas déjà été utilisés)
Historique des versions :	Notes de mise à jour

Obtenir le reçu de l'envoi – Résumé du service

Détails sur la demande

Structure de la demande pour le service « Obtenir le reçu de l'envoi »

Point final

Il faut utiliser le lien associé à une demande de service précédente lorsque rel= "receipt" (voir la section Points finaux fournis).

En-têtes HTTP

Variable des en-têtes HTTP	Valeur
Accept	application/vnd.cpc.shipment-v8+xml (Remarque : / à la place de la valeur de l’en-tête affichera un message d’erreur)
Authorization	Basic {Encodage 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 « Obtenir le reçu de l'envoi ».

Détails de la réponse

Réponse – Éléments

Le tableau suivant offre un aperçu général des données XML figurant dans la réponse.

Obtenir le reçu de l'envoi – Aperçu détaillé des éléments de réponse
Nom de l'élément	Type	Description
shipment-receipt	Complexe	Niveau supérieur de la structure XML pour la réponse.
cc-receipt-details	Complexe	Cette structure contient les détails requis pour un reçu de carte de crédit.
merchant-name	Simple	La valeur sera la suivante : « Canada Post ».
merchant-url	Simple	La valeur sera la suivante : "www.canadapost.ca".
name-on-card	Simple	Nom figurant sur la carte de crédit par défaut sauvegardée par Postes Canada.
auth-code	Simple	Code d'autorisation reçu de la société émettrice de la carte de crédit.
auth-timestamp	Simple	Date et heure auxquelles la transaction a été autorisée par la société émettrice de cartes de crédit.
card-type	Simple	Type de carte de crédit utilisé pour l'achat.
charge-amount	Simple	Montant total facturé sur la carte de crédit.
currency	Simple	Devise de la transaction : CAD.
transaction-type	Simple	La valeur sera la suivante : « Sale ».
supplier-account-receipt-details	Complexe	Cette structure sera fournie uniquement si l’envoi a été payé par compte de fournisseur. Cette structure n’est pas retournée dans l’environnement « bac à sable ».
merchant-name	Simple	La valeur sera la suivante : "Canada Post".
merchant-url	Simple	La valeur sera la suivante : "www.canadapost.ca".
auth-code	Simple	Le code d’autorisation reçu du fournisseur.
auth-timestamp	Simple	La date et l’heure auxquelles le fournisseur a autorisé la transaction.
supplier-id	Simple	Le fournisseur qui a autorisé la transaction. Les valeurs sont : FP = FrancoTyp Postalia NE = Neopost PB = Pitney Bowes
charge-amount	Simple	Le montant total facturé au compte.
currency	Simple	La devise de la transaction; toujours CAD.
transaction-type	Simple	La valeur sera la suivante : "Sale".

Réponse – Diagramme XML

Obtenir le reçu de l'envoi – Structure de la réponse XML

Réponse – Réponse d'erreur possible

Dans le cas d'une erreur d'application, le corps du message XML aura une structure du message d'erreur plutôt qu'une réponse de réussite, mais le code HTTP sera 200. Pour obtenir de plus amples renseignements, veuillez consulter la section Codes de statut HTTP.

Exemples

Exemple de demande REST – Obtenir le reçu de l'envoi


  GET https://XX/rs/1234567/1234567/shipment/123456789012345678/receipt

    Accept:application/vnd.cpc.shipment-v8+xml

    Authorization:Basic s7HD7gwsennesc==

Nota : Le lien vers le point final HTTP et la valeur « Accept » ne doivent pas être intégrés. Ces valeurs doivent plutôt être fournies à titre de données de sortie pour les services Créer l'envoi et Obtenir l'envoi.

Exemple de réponse XML – Obtenir le reçu de l'envoi


  
	
 <shipment-receipt>

	  <cc-receipt-details>

	  <merchant-name>Canada Post Corporation</merchant-name>

	  <merchant-url>www.canadapost.ca</merchant-url>

	  <name-on-card>John Doe</name-on-card>

	  <auth-code>076838</auth-code>

	  <auth-timestamp>2013-06-17T08:27:20-05:00</auth-timestamp>

	  <card-type>VIS</card-type>

	  <charge-amount>21.99</charge-amount>

	  <currency>CAD</currency>

	  <transaction-type>Sale</transaction-type>

	  </cc-receipt-details>

	  </shipment-receipt>

Ouvrir unesession

Ressources