Expédition avec convention
Obtenir le tarif de l'envoi – Module SOAP
Résumé
| Nom : | Obtenir le tarif de l'envoi |
|---|---|
| Raison pour utiliser le service : | Pour récupérer les renseignements tarifaires sur l'envoi à partir d'un envoi créé précédemment |
| Données d'entrée : | Mailed-by; shipment-id; locale (optionnel) |
| Données de sortie : | Les détails liés au tarif en format XML, les options et les taxes sont décrits séparément. |
| Exemple d'erreur : | Adresse invalide ou poids dépassant 30 kg |
| Demande de service précédente habituelle : | |
| 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 : |
Obtenir le tarif 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 : | GetShipmentPrice |
Corps – SOAP
La présente section décrit les éléments XML d'entrée pour ce service. Pour obtenir la structure hiérarchique, consultez le diagramme XML.
| Obtenir le tarif de l'envoi – Éléments de la demande | |||
|---|---|---|---|
| Nom de l'élément | Type | Requis/Optionnel | Description |
get-shipment-price-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 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 XML
Obtenir le tarif de l'envoi – Structure de la demande 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. Pour obtenir la hiérarchie de la réponse, consultez le diagramme XML.
| Obtenir le tarif de l'envoi – Éléments de la réponse | ||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Nom de l'élément | Type | Description | ||||||||||||||||||||||||||||||||
get-shipment-price-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-price |
Complexe |
Structure XML contenant les résultats liés à l'exécution réussie du service en question. |
||||||||||||||||||||||||||||||||
service-code |
Simple |
Il s'agit du code du service de livraison utilisé pour la livraison de l'envoi. Les codes les plus fréquemment utilisés sont énumérés ci-dessous.
(Nota : Les services de livraison et leurs codes peuvent être obtenus en faisant appel aux services |
||||||||||||||||||||||||||||||||
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 |
||||||||||||||||||||||||||||||||
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 |
Simple |
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. |
||||||||||||||||||||||||||||||||
due-amount |
Simple |
Il s'agit du montant total dû pour l'envoi. |
||||||||||||||||||||||||||||||||
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-transmit-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. *Devrait être « expected-transit-time »; l’erreur typographique sera corrigée dans la prochaine version. |
||||||||||||||||||||||||||||||||
expected-delivery-date |
Simple |
(Format de la date : AAAA-MM-JJ) 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 poids réel et l’équivalent volumétrique du poids réel, selon la plus élevée des deux valeurs. |
||||||||||||||||||||||||||||||||
Réponse – Diagramme XML
Réponse – Réponses d'erreur possibles
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 tarif de l'envoi
<get-shipment-price-request>
<mailed-by>1111111</mailed-by>
<locale>EN</locale>
<shipment-id>340531309186521749</shipment-id>
</get-shipment-price-request>
Exemple de réponse XML selon le module SOAP – Obtenir le tarif de l'envoi
<get-shipment-price-response>
<shipment-price>
<service-code>DOM.EP</service-code>
<base-amount>12.92</base-amount>
<priced-options>
<priced-option>
<option-code>DC</option-code>
<option-price>0</option-price>
</priced-option>
</priced-options>
<adjustments>
<adjustment>
<adjustment-code>AUTDISC</adjustment-code>
<adjustment-amount>0.00</adjustment-amount>
</adjustment>
<adjustment>
<adjustment-code>FUELSC</adjustment-code>
<adjustment-amount>1.29</adjustment-amount>
</adjustment>
</adjustments>
<pre-tax-amount>21.71</pre-tax-amount>
<gst-amount>0.00</gst-amount>
<pst-amount>0</pst-amount>
<hst-amount>2.82</hst-amount>
<due-amount>24.53</due-amount>
<service-standard>
<am-delivery>false</am-delivery>
<guaranteed-delivery>true</guaranteed-delivery>
<expected-transmit-time>1</expected-transmit-time>
<expected-delivery-date>2011-09-22</expected-delivery-date>
</service-standard>
<rated-weight>110</rated-weight>
</shipment-price>
</get-shipment-price-response>
