Ramassage

Exemples de codes pour ramassage : Java (.zip) | PHP (.zip) | C# (.zip)

Obtenir le tarif de ramassage – Module REST

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 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 articles sont ramassés gratuitement)
Données de sortie : Informations sur le prix
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

Détails sur la demande

Demande – Structure pour le service Obtenir le tarif de ramassage

Point final

POST https://XX/enab/\{customer}/pickuprequest/price

Remplacez... Par...

XX (Conception)

ct.soa-gw.postescanada.ca

XX (Production)

soa-gw.canadapost.ca

{customer}

Votre numéro de client

En-têtes HTTP

Variable des en-têtes HTTP

Valeur

Accept

application/vnd.cpc.pickuprequest+xml (Remarque : */* à la place de la valeur de l’en-tête affichera un message d’erreur)

Content-Type

application/vnd.cpc.pickuprequest+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

<?xml version="1.0" encoding="utf-8"?>
<pickup-request-details xmlns="http://www.canadapost.ca/ws/pickuprequest">
xxx
</pickup-request-price>

Demande – Éléments

Le tableau ci-dessous décrit les éléments XML d'entrée pour le service « Obtenir le tarif de ramassage ». Pour obtenir la structure hiérarchique des entrées, consultez le diagramme XML.

Obtenir le tarif de ramassage – Éléments de la demande
Nom de l'élément Type Requis/Facultatif Description

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 que les articles du service PrioritéMC seront dans la demande de 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

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

Frais de base pour le ramassage.

gst-amount

Simple

Montant pour la TPS.

pst-amount

Simple

Montant pour la taxe de vente provinciale.

hst-amount

Simple

Montant de la TVH.

due-amount

Simple

Total des frais.

Réponse – Diagramme XML

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

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

Réponses d'erreur possibles

Une demande bien structurée peut recevoir l'une des réponses d'erreur d'application suivantes :

Code Description

11003

La date est passée ou invalide.

11005

Le client n’est pas valide ou bloqué.

Voir aussi les sections Codes de statut HTTP et Messages d'erreur et stratégies d'atténuation.

Exemples

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

POST https://XX/enab/\{customer}/pickuprequest/price

<pickup-details>
<date>2016-07-18</date>
<contract-id>12345678</contract-id>
<pww-flag>false</pww-flag>
<priority-flag>false</priority-flag>
</pickup-details>

Exemple de réponse d’erreur

<pickup-details>
<date>2016-07-18</date>
<contract-id>12345678</contract-id>
<pww-flag>false</pww-flag>
<priority-flag>false</priority-flag>
</pickup-details>

Environnement « Bac à sable » (développement) pour la réponse XML – 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.