Tarification

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

Obtenir le service – Module SOAP

Résumé

Nom :	Obtenir le service
Raison pour utiliser le service :	Pour trouver des détails sur un service postal donné, notamment les limites de dimensions et de poids ainsi que les options disponibles
Données d'entrée :	Service (pays – facultatif)
Données de sortie :	Description du service, options et restrictions
Demande de service précédente habituelle :	Obtenir les tarifs ou Découvrir les services
Historique des versions :	Notes de diffusion

Détails sur la demande

WSDL:	rating.wsdl
Point final (Conception) :	https://ct.soa-gw.canadapost.ca/rs/soap/rating/v4
Point final (Production) :	https://soa-gw.canadapost.ca/rs/soap/rating/v4
Espace de nommage :	http://www.canadapost.ca/ws/soap/ship/rate/v4
Opération :	GetService

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 service – Éléments de la demande
Nom de l'élément	Type	Requis/Optionnel	Description
get-service-request	complexe	requis	Élément XML de niveau supérieur de la structure de la réponse
locale	simple	optionnel	Indique 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.
service-code	simple	requis	Identificateur de service pour le service d'expédition. Chaîne alphanumérique jusqu'à 10 lettres/chiffres.
destination-country-code	simple	optionnel	Code de pays de deux caractères représentant le pays de destination Ce paramètre précisera les options disponibles pour le service d'expédition que vous avez indiqué ci-dessus dans le code de service. Par exemple, certains pays acceptent l'option Signature pour le service Xpresspost^MC – International, tandis que d'autres ne l'acceptent pas. Nota : Nous ne validons pas si le service d'expédition que vous avez précisé est un service valide pour le pays que vous avez indiqué. Par conséquent, même si le service n'est pas offert pour le pays que vous avez indiqué, une liste d'options par défaut sera tout de même produite.

Demande – Diagramme XML

Obtenir le service – 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 service. Pour obtenir la hiérarchie de la réponse, consultez le diagramme XML.

Obtenir le service – Éléments de la réponse
Nom de l'élément	Type	Description
get-service-response	complexe	Niveau supérieur de l'élément XML pour la réponse. Ce niveau affichera les résultats d'une exécution réussie ou la structure d'un message d'erreur.
service-code	complexe	Structure contenant tous les renseignements sur le service demandé
service-code	simple	Identificateur de service
service-name	simple	Description du service dans la langue privilégiée
comment	simple	Message indiquant le montant maximal de couverture inclus avec ce service (qui peut être aucune); l’information est retournée uniquement pour quelques services vers les É.-U. et le régime international pour lesquels on ne peut pas acheter une couverture supplémentaire. S'applique seulement à la version 2 du schéma et aux versions ultérieures.
options	complexe	Liste d'options disponibles ou applicables à ce service
option	complexe	Option précise
option-name	simple	Nom de l'option dans la langue privilégiée
option-code	simple	Code utilisé pour sélectionner l'option pour le service Obtenir les tarifs ou Créer l'envoi
mandatory	simple	Vrai \| Faux Indique si cette option est obligatoire pour le service.
qualifier-required	simple	Vrai \| Faux La mention « Vrai » signifie que cette option doit inclure un qualificatif si elle est sélectionnée. C'est le cas pour les options Couverture (COV) et Contre remboursement (COD).
qualifier-max	simple	Le code numérique correspond à la valeur maximale du qualificatif pour ce service. La valeur maximale d'un qualificatif peut varier selon les services. Cet élément est propre à l'option Couverture (COV).
restrictions	complexe	Décrit les restrictions relatives aux dimensions et au poids pour les colis expédiés par l'intermédiaire de ce service.
weight-restriction	complexe	Décrit les restrictions relatives au poids pour les articles expédiés par l'intermédiaire de ce service.
min	attribut de la restriction relative au poids	Poids minimal en grammes
max	attribut de la restriction relative au poids	Poids maximal en grammes pouvant être envoyé par l'intermédiaire de ce service
dimensional-restrictions	complexe	Décrit les restrictions relatives aux dimensions pour les articles expédiés par l'intermédiaire de ce service.
length	complexe	Précise la gamme de dimensions de la dimension la plus longue pour un envoi en centimètres.
width	complexe	Précise la gamme de dimensions de la deuxième dimension la plus longue pour un envoi en centimètres.
height	complexe	Précise la gamme de dimensions de la dimension la plus courte pour un envoi en centimètres.
min	attribut de la longueur, de la largeur et de la hauteur	Mesure minimale en centimètres allouée pour la dimension
max	attribut de la longueur, de la largeur et de la hauteur	Mesure maximale en centimètres allouée pour la dimension
length-plus-girth-max	simple	Valeur maximale calculée : Longueur + (2 x Largeur) + (2 x Hauteur) (en centimètres)
length-height-width-sum-max	simple	Valeur maximale : Longueur + Largeur + Hauteur (en centimètres)
oversize-limit	simple	Si l'une des dimensions dépasse cette limite, un droit supplémentaire pour article surdimensionné s'appliquera à l'envoi (en centimètres).
density-factor	simple	Facteur de densité standard utilisé pour calculer l'équivalent volumétrique du poids réel. Remarque : Postes Canada peut utiliser un autre facteur pour calculer l’équivalent volumétrique, selon votre convention du service de colis.
can-ship-in-mailing-tube	simple	Vrai \| Faux La mention « Vrai » indique que les colis expédiés par l'intermédiaire de ce service peuvent être expédiés dans un tube d'expédition (l'option CYL peut être utilisée).
can-ship-unpackaged	simple	Vrai \| Faux La mention « Vrai » indique que les colis expédiés par l'intermédiaire de ce service peuvent être expédiés sans être emballés (l'option UP peut être utilisée).
allowed-as-return-service	simple	Vrai \| Faux La mention « Vrai » indique que ce service peut être utilisé dans return-spec d'une demande de service Créer l'envoi.

Réponse – Diagramme XML

Obtenir le service – Structure de la réponse XML

Voir l'image en taille réelle

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 service


  

    <get-service-request>
    <locale>EN</locale>

    <service-code>INT.XP</service-code>

    <destination-country-code>AU</destination-country-code>

  
    </get-service-request>

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

    <get-service-response>
    <service>
  
    <service-code>INT.XP</service-code>

    <service-name>Xpresspost International</service-name>

    <options>
  
    <option>
  
    <option-code>COV</option-code>

    <option-name>Coverage</option-name>

    <mandatory>false</mandatory>

    <qualifier-required>true</qualifier-required>

    <qualifier-max>1000</qualifier-max>

  
    </option>

    <option>
  
    <option-code>DC</option-code>

    <option-name>Delivery confirmation</option-name>

    <mandatory>true</mandatory>

    <qualifier-required>false</qualifier-required>

  
    </option>

    <option>
  
    <option-code>RASE</option-code>

    <option-name>Return at sender's expense</option-name>

    <mandatory>true</mandatory>

    <qualifier-required>false</qualifier-required>

  
    </option>

  
    </options>

    <restrictions>
  
    <weight-restrictionmin="0"max="20000"></weight-restriction>

    <dimensional-restrictions>
  
    <lengthmin="0.1"max="100"></length>

    <widthmin="0.1"max="100"></width>

    <heightmin="0.1"max="100"></height>

    <length-plus-girth-max>200</length-plus-girth-max>

    <oversize-limit>100</oversize-limit>

  
    </dimensional-restrictions>

    <density-factor>6000</density-factor>

    <can-ship-in-mailing-tube>true</can-ship-in-mailing-tube>

    <can-ship-unpackaged>false</can-ship-unpackaged>

    <allowed-as-return-service>false</allowed-as-return-service>

  
    </restrictions>

  
    </service>

  
    </get-service-response>

Ouvrir unesession

Ressources