Ramassage

Créer une demande de ramassage – Module SOAP

Résumé

Nom :	Obtenir le tarif de ramassage
Raison pour utiliser le service :	Pour connaître le prix demandé à un client pour un ramassage sur demande. (Varie de « gratuit » pour les clients titulaires d’une convention à une gamme de frais, selon la quantité et le type de colis ramassés.) Remarque : Ce service confirme un prix qui serait facturé à une date précise. Ne pas l’utiliser pour confirmer si le service de ramassage est offert à cette date.
Données d'entrée :	Numéro du client Numéro de convention, le cas échéant Indiquer si l’envoi à ramasser est un envoi PrioritéMC (ces envois sont ramassés gratuitement)
Données de sortie :	Renseignements sur les tarifs
Demande de service précédente habituelle :	Obtenir la disponibilité du service de ramassage
Prochaine demande de service habituelle :	Créer une demande de ramassage
Historique des versions :	Notes de mise à jour

Obtenir le tarif de ramassage – Résumé du service

Détails sur la demande

WSDL :	pickup.wsdl
Point final (Conception) :	https://ct.soa-gw.canadapost.ca/enab/soap/pickuprequest
Point final (Production) :	https://soa-gw.canadapost.ca/enab/soap/pickuprequest
Espace de nommage :	http://www.canadapost.ca/ws/soap/pickuprequest
Opération :	GetPickupPrice

Corps – SOAP

La présente section décrit les éléments XML d'entrée pour créer une demande de ramassage. Pour obtenir la structure hiérarchique, consultez le diagramme XML.

Obtenir le tarif de ramassage – Éléments de la demande
Nom de l'élément	Type	Requis/Facultatif	Description
get-pickup-price-request	Complexe	Requis	Élément XML de niveau supérieur de la structure de la réponse.
locale	Simple	Facultatif	Votre langue de préférence pour recevoir les messages d'erreur. EN = Anglais FR = Français Si aucune valeur n'est saisie, la langue par défaut est l'anglais.
platform-id	Simple	Facultatif	Numéro de client de la plateforme. S'applique seulement aux plateformes de cybercommerce.
pickup-details	Complexe	Requis	Élément XML de niveau supérieur de la structure de la réponse. Rappel : Ces demandes concernent les ramassages sur demande
contract-id	Simple	Facultatif	Votre numéro de convention de colis, si vous en avez un. (chaîne numérique à 10 chiffres maximum) Remarque : Vous pouvez ignorer cet élément. Il sera utilisé dans une version future.
date	Simple	Facultatif	Date de ramassage. Format de la date (aaaa-mm-jj). Date du jour par défaut. Important : Seulement utilisé pour établir le tarif à cette date; aucune vérification n’est effectuée pour confirmer que le ramassage est possible.
priority-flag	Simple	Facultatif	{vrai, faux} Indique si des articles prioritaires peuvent être disponibles pour le ramassage. La valeur par défaut est «faux».
alternate-address-postal-code	Simple	Facultatif	Le code postal de l’adresse où le ramassage doit être effectué. Requis seulement si le ramassage doit être effectué à une adresse autre que l’adresse commerciale indiquée dans votre profil de Postes Canada. Format A9A9A9 ou A9A 9A9. Remarque : La province serait déterminée à partir de ce code postal lors du calcul des taxes.

Demande – Diagramme XML

Obtenir le tarif de ramassage – Structure de la demande XML

Détails de la réponse

Réponse – Éléments

Le tableau ci-dessous décrit les champs XML dans la réponse. Pour obtenir la hiérarchie de la réponse, consultez le diagramme XML.

Obtenir le tarif de ramassage – Éléments de la réponse
Nom de l'élément	Type	Description
pickup-request-price	Complexe	Élément XML de niveau supérieur de la structure de la réponse. Fournit les frais pour un ramassage sur demande selon les paramètres indiqués dans la demande.
pre-tax-amount	Simple	Tarif de base du ramassage.
gst-amount	Simple	Montant de la taxe sur les produits et services.
pst-amount	Simple	Montant de la taxe de vente provinciale.
hst-amount	Simple	Montant de la taxe de vente harmonisée.
due-amount	Simple	Total des frais.

Réponse – Diagramme XML

Obtenir le tarif de ramassage – Structure de la réponse XML

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 plus de renseignements, consultez les Principes de base liés au module SOAP pour les services en ligne de Postes Canada.

Les messages d'erreur possibles pour ce service sont les suivants :

Code	Description
11003	La date est passée ou invalide.
11005	Le client n’est pas valide ou bloqué.

Consultez également la section Messages d'erreur et stratégies d'atténuation.

Exemples

Exemple de demande XML selon le module SOAP – Obtenir le tarif de ramassage


      
        <get-pickup-price-request>

 <customer-number>1234567</customer-number>

 <locale>EN</locale>

 <pickup-details>

 <date>2016-07-18</date>

 <contract-id>12345678</contract-id>

 <pww-flag>false</pww-flag>

 <priority-flag>false</priority-flag>

 </pickup-details>

</get-pickup-request-details-request>

Exemple de réponse XML selon le module SOAP – Obtenir le tarif de ramassage


      <get-pickup-price-response>

 <pickup-request-price>

 <pre-tax-amount>3.50</pre-tax-amount>

 <gst-amount>0.18</gst-amount>

 <pst-amount>0.35</pst-amount>

 <due-amount>4.03</due-amount>

 </pickup-request-price>

</get-pickup-price-response>

Réponse XML dans l’environnement de développement (bac à sable) – Obtenir le tarif de ramassage

La réponse est fixe (statique) dans l’environnement de conception; vous obtiendrez toujours une réponse de 3,50 $ plus la TPS de 15 % (comme dans les exemples ci-dessus). Dans les situations concrètes, les taxes correspondront à celles en vigueur dans votre province ou dans la province de l’autre adresse fournie, le cas échéant.

Ouvrir unesession

Ressources