Expédition sans convention

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

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

Résumé

Nom : Obtenir le reçu de l'envoi sans convention
Raison pour utiliser le service : Cette demande de service permet d'obtenir les frais liés à l'étiquette et les renseignements sur le règlement en format XML. Les données de la réponse peuvent être formatées pour imprimer un reçu de carte de crédit.
Données d'entrée : Numéro d'identification de l'envoi
Données de sortie : Détails du reçu en format XML
Demande de service précédente habituelle : Créer l'envoi sans convention ou Obtenir l'envoi sans convention
Prochaine demande de service habituelle : Obtenir l'artefact ou Créer l'envoi sans convention
Historique des versions : Notes de mise à jour

Détails sur la demande

Demande – Structure pour le service « Obtenir le reçu de l'envoi sans convention »

Point final

GET https://XX/rs/{Client « Expédié par »}/ncshipment/{Numéro d'identification de l'envoi}/receipt

Remplacez... Par...

XX (Conception)

ct.soa-gw.canadapost.ca

XX (Production)

soa-gw.canadapost.ca

{Client « Expédié par »}

Votre numéro de client*

{Numéro d'identification de l'envoi}

Numéro d'identification de l'envoi pertinent*

*Le lien fourni par la demande de service « Créer l'envoi sans convention » ou « Obtenir l'envoi sans convention » remplacera {Client « Expédié par »} par votre numéro de client et {Numéro d'identification de l'envoi} par le bon numéro d'identification de l'envoi.

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-receipt xmlns="http://www.canadapost.ca/ws/ncshipment-v4">
xxx
</non-contract-shipment-receipt>

Demande – Éléments

Les données d'entrée XML ne sont pas nécessaires pour le service « Obtenir le reçu de l'envoi sans convention ».

Détails de la réponse

Réponse – Éléments

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

non-contract-shipment-receipt

Complexe

Il s'agit du niveau supérieur de la structure XML pour la réponse.

final-shipping-point

Simple

Il s'agit du code postal du bureau de poste où l'envoi doit être déposé.

shipping-point-name

Simple

Il s'agit du nom descriptif du point d'expédition.

shipping-point-id

Simple

Il s'agit du numéro d'identification de Postes Canada pour le point d'expédition.

mailed-by-customer

Simple

Il s'agit du numéro de client à 10 chiffres pour le client « Expédié par ».

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 de l'autorisation.
La date et l'heure sont précisées dans le format XML standard « AAAA-MM-JJThh:mm:ss » lorsque :

  • « AAAA » = Année
  • « MM » = Mois
  • « JJ » = Journée
  • « T » = Début de la section de temps requise
  • « hh » = Heure
  • « mm » = Minute
  • « ss » = Seconde

card-type

Simple

Type de carte utilisé pour l'achat.

La valeur doit être l'une des suivantes :
- MC
- VIS
- AME

charge-amount

Simple

Montant total facturé sur la carte de crédit pour l'étiquette ou le service d'expédition.

currency

Simple

Devise de la transaction : CAD.

transaction-type

Simple

Type de transaction par carte de crédit : Sale.

service-code

Simple

Il s'agit du service de livraison de Postes Canada utilisé pour expédier l'article.

Peut être l'un des services suivants :

Service-Code Description
Régime intérieur
DOM.RP Colis standard
DOM.EP Colis accélérés
DOM.XP Xpresspost
DOM.PC Priorité
États-Unis

USA.PW.ENV

Enveloppe Priorité Mondial – É.-U.

USA.PW.PAK

Paquet Priorité Mondial – É.-U.

USA.PW.PARCEL

Colis Priorité Mondial – É.-U.

USA.XP

Xpresspost É.-U.

USA.EP

Colis accélérés É.-U.

USA.SP.AIR

Petit paquet-avion à destination des É.-U.

USA.SP.SURF

Petit paquet de surface à destination des É.-U.

Régime international

INT.PW.ENV

Enveloppe Priorité Mondial – International

INT.PW.PAK

Paquet Priorité Mondial – International

INT.PW.PARCEL

Colis Prioritié Mondial – International

INT.XP

Xpresspost – International

INT.SP.AIR

Petits paquets-avion du régime international

INT.SP.SURF

Petits paquets de surface du régime international

Il s'agit du code du service de livraison utilisé pour la livraison de l'envoi.

base-amount

Simple

Il s'agit du coût de base pour l'expédition en dollars canadiens.

priced-options

Complexe

Cette structure contient la liste d'options appliquées à cet envoi et l'incidence tarifaire connexe.

Cet élément sera absent s'il n'y a aucune option appliquée au tarif de cet envoi.

priced-option

Complexe

Occurrence (1 à N fois).

Chaque occurrence correspond à une structure représentant une option d'expédition qui s'applique à l'envoi et qui pourrait avoir une incidence sur le tarif de cet envoi.

option-code

Simple

Il s'agit du code d'option pour une option appliquée à cet envoi.

Voici des exemples de codes d'option :
COD – Contre remboursement
COV – Couverture
CYL – Tube d'expédition
DC – Confirmation de livraison
PA18 – Preuve d'âge (18 ans)
PA19 – Preuve d'âge (19 ans)
SO – Option Signature
UP – Non emballé

option-price

Simple

Il s'agit de la composante totale du tarif attribuable à l'option. Les unités s'affichent en dollars canadiens.

adjustments

Complexe

Cette structure contient la liste de rajustements appliqués à cet envoi et l'incidence tarifaire connexe.

Cet élément sera absent s'il n'y a aucun rajustement appliqué au tarif de cet envoi.

adjustment

Complexe

Occurrence (1 à N fois).

Cette structure représente un rajustement apporté à l'expédition qui s'applique à l'envoi, ce qui pourrait avoir une incidence tarifaire sur l'envoi.

adjustment-code

Simple

Il s'agit du code de rajustement désignant le rajustement appliqué à cet envoi.

adjustment-amount

Il s'agit du coût total attribuable au rajustement.

pre-tax-amount

Simple

Il s'agit du montant total avant les taxes pour le tarif d'expédition.

gst-amount

Simple

Il s'agit du montant de TPS ajouté au prix de base.

pst-amount

Simple

Il s'agit du montant de TVP ajouté au prix de base.

hst-amount

Simple

Il s'agit du montant de TVH ajouté au prix de base.

service-standard

Complexe

Cette structure représente la norme de service selon laquelle cet envoi sera livré.

am-delivery

Simple

{vrai, faux}

Cela indique si la livraison le matin fait partie de la norme de service.

guaranteed-delivery

Simple

{vrai, faux}

Cela indique si la garantie de livraison fait partie de la norme de service.

expected-transit-time

Simple

Il s'agit du nombre de jours pendant lesquels le paquet devrait se trouver dans le flot du courrier, c'est-à-dire depuis le dépôt jusqu'à la livraison.

expected-delivery-date

Simple

Il s'agit de la date de livraison approximative en fonction de la date de création de l'envoi ou de la date de dépôt prévue fournie dans la demande de création si elle dépasse la date de livraison prévue.

rated-weight

Simple

Il désigne le poids réel ou l'équivalent volumétrique utilisé pour déterminer le tarif de base, dans le cadre des limites prescrites en matière de poids et de dimensions pour le produit concerné, à partir du calcul de Postes Canada ou de votre déclaration, selon la plus élevée des deux valeurs.

Réponse – Diagramme XML

Le diagramme suivant présente la structure de données XML de la réponse pour le service « Obtenir le reçu de l'envoi sans convention ».

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

Réponse – Réponses d'erreur possibles

Aucune erreur n'est prévue pour l'utilisation du service « Créer l'envoi sans convention » ou « Obtenir l'envoi sans convention ». Toutefois, pour obtenir les réponses d'erreur générales, consultez la section Codes de statut HTTP.

Exemples

Exemple de demande XML selon le module REST – Obtenir le reçu de l'envoi sans convention

Il n'y a pas de XML lié à cette demande REST. Utilisez le lien fourni dans une demande préalable ou consultez les fichiers du projet soapUI pour obtenir des exemples de demande.

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

<non-contract-shipment-receipt>
<final-shipping-point>J4W4T0</final-shipping-point>
<shipping-point-name>BP BROSSARD</shipping-point-name>
<shipping-point-id>0192</shipping-point-id>
<mailed-by-customer>0001111111</mailed-by-customer>
<service-code>DOM.EP</service-code>
<rated-weight>15.000</rated-weight>
<base-amount>18.10</base-amount>
<pre-tax-amount>19.46</pre-tax-amount>
<gst-amount>0.00</gst-amount>
<pst-amount>0.00</pst-amount>
<hst-amount>2.53</hst-amount>
<priced-options>
<priced-option>
<option-code>DC</option-code>
<option-price>0</option-price>
</priced-option>
</priced-options>
<adjustments>
<adjustment>
<adjustment-code>FUELSC</adjustment-code>
<adjustment-amount>1.36</adjustment-amount>
</adjustment>
</adjustments>
<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>2012-03-13T08: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>
<service-standard>
<am-delivery>false</am-delivery>
<guaranteed-delivery>true</guaranteed-delivery>
<expected-transit-time>1</expected-transit-time>
<expected-delivery-date>2012-03-14</expected-delivery-date>
</service-standard>
</non-contract-shipment-receipt>