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 SOAP

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 :

Expédié par; numéro d'identification de l'envoi; paramètre régional (optionnel)

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

Obtenir le reçu de 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 : GetShipmentReceipt

Corps – SOAP

La présente section décrit les éléments XML d'entrée pour ce service.

Obtenir le reçu de l'envoi – Éléments de la demande
Nom de l'élément Type Requis/Optionnel Description

get-shipment-receipt-request

complexe

requis

Élément XML de niveau supérieur de la structure de la réponse.

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 ».

shipment-id

simple

requis

(Chaîne alphanumérique – Jusqu'à 32 lettres/chiffres)

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 XM

Obtenir le reçu de l'envoi – Structure de la réponse XML
Obtenir le reçu de l'envoi – Structure de la réponse 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 tarif de l'envoi.

Obtenir le reçu de l'envoi – Éléments de la réponse
Nom de l'élément Type Description

get-shipment-receipt-response

Complexe

Il s'agit de l'élément XML de niveau supérieur de la structure de la réponse.

Il affichera les résultats d'une exécution réussie ou la structure d'une erreur.

shipment-receipt

Complexe

Structure XML contenant les les détails requis pour un reçu.

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 – Réponse d'erreur possible

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.

Exemples

Exemple de demande XML selon le module SOAP – Obtenir le reçu de l'envoi

<get-shipment-receipt-request>
<mailed-by>1111111</mailed-by>
<locale>EN</locale>
<shipment-id>340531309186521749</shipment-id>
</get-shipment-Receipt-request>

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

<get-shipment-receipt-response>
<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>
</get-shipment-receipt-response>