Expédition avec convention
Obtenir le tarif de l'envoi – Module REST
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 : | Utiliser le lien associé au service Créer l'envoi ou Obtenir l'envoi lorsque rel= "price" |
| 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 : | La date de dépôt doit être postérieure ou correspondre à la date de la journée en cours. |
| 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
Structure de la demande pour obtenir le tarif de l'envoi
Point final
Il faut utiliser le lien associé à une demande de service précédente lorsque rel= "price" (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 tarif 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 tarif de l'envoi – Aperçu détaillé des éléments de réponse | ||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Nom de l'élément | Type | Description | ||||||||||||||||||||||||||||||||
shipment-price |
Complexe |
Niveau supérieur de la structure XML pour la réponse |
||||||||||||||||||||||||||||||||
service-code |
Simple |
(Chaîne de caractères – Jusqu'à 32 caractères) Doit être un code valide correspondant au service de livraison de Postes Canada utilisé pour expédier l'article. 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 Obtenir les tarifs et Découvrir les services décrits dans la section Tarification.) Fait partie du shipment-price. Il s'agit du service-code de livraison utilisé pour la livraison de l'envoi. |
||||||||||||||||||||||||||||||||
base-amount |
Simple |
(Champ numérique de six chiffres, suivis de deux décimales [p. ex. format 999999.99]) Fait partie du shipment-price. Il s'agit du coût de base pour l'expédition en dollars canadiens. |
||||||||||||||||||||||||||||||||
priced-options |
Complexe |
Fait partie du shipment-price. 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 |
Fait partie des priced-options. 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 |
(Chaîne de caractères – Jusqu'à 10 caractères) Fait partie de l'option. 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 |
(Champ numérique de six chiffres, suivis de deux décimales [p. ex. format 999999.99]) Fait partie de l'option. Il s'agit de la composante totale du tarif attribuable à l'option. Les unités s'affichent en dollars canadiens. |
||||||||||||||||||||||||||||||||
adjustments |
Complexe |
Fait partie du price. 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 |
Fait partie des adjustments. 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 |
(Champ numérique de six chiffres, suivis de deux décimales [p. ex. format 999999.99]) Fait partie de option. Il s'agit du coût total attribuable au rajustement. |
|||||||||||||||||||||||||||||||||
pre-tax-amount |
Simple |
(Champ numérique de six chiffres, suivis de deux décimales [p. ex. format 999999.99]) Fait partie du shipment-price. Il s'agit du montant total avant les taxes pour le tarif d'expédition. |
||||||||||||||||||||||||||||||||
gst-amount |
Simple |
(Champ numérique de six chiffres, suivis de deux décimales [p. ex. format 999999.99]) Fait partie du shipment-price. Il s'agit du montant de TPS ajouté au prix de base. |
||||||||||||||||||||||||||||||||
pst-amount |
Simple |
(Champ numérique de six chiffres, suivis de deux décimales [p. ex. format 999999.99]) Fait partie du shipment-price. Il s'agit du montant de TVP ajouté au prix de base. |
||||||||||||||||||||||||||||||||
hst-amount |
Simple |
(Champ numérique de six chiffres, suivis de deux décimales [p. ex. format 999999.99]) Fait partie du shipment-price. Il s'agit du montant de TVH ajouté au prix de base. |
||||||||||||||||||||||||||||||||
due-amount |
Simple |
(Champ numérique de six chiffres, suivis de deux décimales [p. ex. format 999999.99]) Fait partie du shipment-price. Il s'agit du montant total dû pour l'envoi. |
||||||||||||||||||||||||||||||||
service-standard |
Complexe |
Fait partie du tarif d'expédition. Cette structure représente la norme de service selon laquelle cet envoi sera livré. |
||||||||||||||||||||||||||||||||
am-delivery |
Simple |
{vrai, faux} Fait partie de la service-standard. Cela indique si la livraison le matin fait partie de la norme de service. |
||||||||||||||||||||||||||||||||
guaranteed-delivery |
Simple |
{vrai, faux} Fait partie de la service-standard. Cela indique si la garantie de livraison fait partie de la norme de service. |
||||||||||||||||||||||||||||||||
expected-transmit-time |
Simple |
(Champ numérique de deux chiffres [p. ex. format 99]) Fait partie de la service-standard. 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) Fait partie de la service-standard. 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 |
(Champ numérique de trois chiffres, suivis de trois décimales [p. ex. format 999.999]) 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éponse d'erreur possible
Aucune erreur n'est prévue pour l'utilisation de ce lien, mais vous apercevrez une erreur 404 si vous utilisez le service Obtenir le tarif de l'envoi plus de 90 jours après que le lien a été fourni.
Pour obtenir de plus amples renseignements, veuillez consulter la section Codes de statut HTTP.
Exemples
Exemple de demande REST – Obtenir le tarif de l'envoi
GET https://XX/rs/1234567/1234567/shipment/123456789012345678 id}/price
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 tarif de l'envoi
<shipment-price>
<service-code>DOM.EP</service-code>
<base-amount>9.19</base-amount>
<priced-options>
<priced-option>
<option-code>DC</option-code>
<option-price>0</option-price>
</priced-option>
<priced-option>
<option-code>UP</option-code>
<option-price>7.50</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>0.90</adjustment-amount>
</adjustment>
</adjustments>
<pre-tax-amount>17.59</pre-tax-amount>
<gst-amount>0.00</gst-amount>
<pst-amount>0</pst-amount>
<hst-amount>2.29</hst-amount>
<due-amount>19.88</due-amount>
<service-standard>
<am-delivery>false</am-delivery>
<guaranteed-delivery>true</guaranteed-delivery>
<expected-transmit-time>2</expected-transmit-time>
<expected-delivery-date>2011-10-07</expected-delivery-date>
</service-standard>
<rated-weight>10.000</rated-weight>
</shipment-price>
