Programme pour développeurs

Prêt à rejoindre le Programme pour développeurs? Inscrivez-vous GRATUITE

Ressources

Expédition avec convention

Exemples de codes pour l'expédition avec convention : Java (.zip) | PHP (.zip) | C# (.zip)

Obtenir les détails du manifeste – Module REST

Résumé

Nom :	Obtenir les détails du manifeste
Raison pour utiliser le service :	Pour récupérer les renseignements qui se trouvent dans le manifeste papier, notamment le coût total du manifeste.
Données d'entrée :	Il faut utiliser le lien associé à une demande de service Obtenir le manifeste lorsque rel="details".
Données de sortie :	Le total des frais d’expédition pour tous les envois dans le manifeste et les renseignements apparaissant sur le reçu du paiement par carte de crédit ou par compte de fournisseur, le cas échéant.
Exemple d'erreur :	404 – Introuvable
Demande de service précédente habituelle :	Obtenir le manifeste
Prochaine demande de service habituelle :	Obtenir l'artefact (si ce service n'a pas déjà été utilisé)
Historique des versions :	Notes de mise à jour

Obtenir les détails du manifeste – Résumé du service

Détails sur la demande

Structure de la demande pour obtenir les détails du manifeste

Point final

Il faut utiliser le lien associé à une demande de service Obtenir le manifeste lorsque rel="details".

(Consultez la section Points finaux fournis)

En-têtes HTTP

HTTP Header Variable	Value
Accept	À partir du media-type dans le lien original (Remarque : / à la place de la valeur de l’en-tête affichera un message d’erreur)
Authorization	Basic {Encodage en 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 les détails du manifeste.

Détails de la réponse

Réponse – Éléments

Le tableau suivant offre un aperçu général des champs XML dans la réponse.

Obtenir les détails du manifeste – Aperçu général des éléments de réponse
Nom de l'élément	Type	Description
manifest-details	Complexe	Structure générale pour les données d'entrée du corps de la demande en format XML
po-number	Simple	(Chaîne alphanumérique – Jusqu'à 10 lettres/chiffres) Fait partie des manifest-details. Il s'agit du numéro du bon de commande utilisé pour la facturation figurant sur le manifeste.
final-shipping-point	Simple	(Chaîne de six caractères alphanumériques) Fait partie des manifest-details. Il s'agit du code postal du bureau de poste où l'envoi doit être déposé.
shipping-point-name	Simple	(Chaîne de caractères – Jusqu'à 3 caractères) Fait partie des manifest-details. Il s'agit du nom descriptif du point d'expédition.
shipping-point-id	Simple	(Chaîne de caractères – Jusqu'à 4 caractères) Fait partie des manifest-details. Il s'agit du numéro d'identification de Postes Canada pour le point d'expédition.
cpc-pickup-indicator	Simple	{true} Affiché si vous avez mentionné que votre courrier est ramassé par Postes Canada à votre emplacement. N'est fourni que quand l'indicateur correspond à « true ».
mailed-by-customer	Simple	(1 à 10 caractères numériques) Fait partie des manifest-details. Il s'agit du numéro de client à 10 chiffres pour le client « Expédié au nom de ».
mailed-on-behalf-of	Simple	(1 à 10 caractères numériques) Fait partie des manifest-details. Il s'agit du numéro de client à 10 chiffres pour le propriétaire du courrier.
paid-by-customer	Simple	(1 à 10 caractères numériques) Fait partie des manifest-details. Il s'agit du numéro de client à 10 chiffres pour le client qui paie l'envoi. Ce numéro est souvent le même que le numéro du client « Expédié au nom de ».
customer-ref	Simple	(Chaîne alphanumérique – Jusqu'à 22 lettres/chiffres) Fait partie des manifest-details. Il s'agit du champ de référence fourni par le client dans la demande de transfert.
manifest-date	Simple	(AAAA-MM-JJ) Fait partie des manifest-details. Il s'agit de la date à laquelle le manifeste a été généré. Nota : Sur le manifeste imprimé, on trouve à la fois la « date du manifeste » et la « date d'expédition ». La date d'expédition est la même que la date du manifeste.
manifest-time	Simple	(HH:MM TZ) : HH = Heure au format 24 heures MM = Minutes TZ = Abréviation pour le fuseau horaire (du serveur) Fait partie des manifest-details. Il s'agit de l'heure à laquelle le manifeste a été généré.
contract-id	Simple	(1 à 15 caractères numériques) Fait partie des manifest-details. Il s’agit du numéro de la convention utilisée pour la tarification de ce manifeste, s’il y a lieu (p. ex., si vous utilisez un service qui n’est pas indiqué dans votre convention, il n’est pas nécessaire d’indiquer le numéro de cette dernière).
method-of-payment	Simple	{Chaîne de caractères – Jusqu'à 10 caractères} Fait partie des manifest-details. Cela indique le mode de paiement du client.
cc-receipt-details	Complexe	Cette structure sera fournie si le manifeste a été payé par carte de crédit dans le cadre d'une demande de service « Transmettre les envois ». Cette structure contient les éléments requis pour une copie papier du reçu de carte de crédit.
supplier-account-receipt-details	Complexe	Cette structure sera offerte si le manifeste a été payé par compte de fournisseur dans la demande Transmettre les envois. Cette structure n’est pas retournée dans l’environnement « bac à sable ».
manifest-pricing-info	Complexe	Fait partie des manifest-details. Cette structure comprend l'information sur la tarification totale de tous les envois inclus dans le manifeste.
manifest-address	Complexe	Fait partie des manifest-details. Cette structure comprend les données d'adressage pour le manifeste s'affichant sur l'étiquette du manifeste.

Le tableau suivant offre un aperçu plus détaillé des données XML dans la réponse.

La structure hiérarchique exacte des résultats XML est présentée dans la section Diagramme XML.

Obtenir les détails du manifeste – Aperçu détaillé des éléments de réponse
Nom de l'élément	Type	Description
merchant-name	Simple	Fait partie des cc-receipt-details. La valeur sera la suivante : « Canada Post ».
merchant-url	Simple	Fait partie des cc-receipt-details. La valeur sera la suivante : « www.canadapost.ca ».
name-on-card	Simple	Fait partie des cc-receipt-details. Nom figurant sur la carte de crédit par défaut sauvegardée par Postes Canada.
auth-code	Simple	Fait partie des cc-receipt-details. Code d'autorisation reçu de la société émettrice de la carte de crédit.
auth-timestamp	Simple	Fait partie des cc-receipt-details. Date et heure auxquelles la transaction a été autorisée par la société émettrice de cartes de crédit.
card-type	Simple	Fait partie des cc-receipt-details. Type de carte de crédit utilisé pour l'achat.
currency	Simple	Fait partie des cc-receipt-details. Devise de la transaction : CAD.
transaction-type	Simple	Fait partie des cc-receipt-details. La valeur sera la suivante : « Sale ».
merchant-name	Simple	Fait partie du paramètre « supplier-account-receipt-details » La valeur sera la suivante : « Canada Post ».
merchant-url	Simple	Fait partie du paramètre « supplier-account-receipt-details » La valeur sera la suivante : « www.canadapost.ca ».
auth-code	Simple	Fait partie du paramètre « supplier-account-receipt-details » Le code d’autorisation reçu du fournisseur.
auth-timestamp	Simple	Fait partie du paramètre « supplier-account-receipt-details » La date et l’heure auxquelles le fournisseur a autorisé la transaction.
supplier-id	Simple	Fait partie du paramètre « supplier-account-receipt-details » Le fournisseur qui a autorisé la transaction. Les valeurs sont : FP = FrancoTyp Postalia NE = Neopost PB = Pitney Bowes
charge-amount	Simple	Fait partie du paramètre « supplier-account-receipt-details » Le montant total facturé au compte.
currency	Simple	Fait partie du paramètre « supplier-account-receipt-details » Devise de la transaction : toujours CAD.
transaction-type	Simple	Fait partie du paramètre « supplier-account-receipt-details » La valeur sera la suivante : « Sale ».
base-cost	Simple	(Champ numérique de six chiffres, suivis de deux décimales [p. ex. format 999999.99]) Fait partie de manifest-pricing-info. Il s'agit du total des coûts de base pour tous les envois figurant sur le manifeste.
automation-discount	Simple	(Champ numérique de six chiffres, suivis de deux décimales [p. ex. format 999999.99]) Fait partie de manifest-pricing-info. Il s'agit du total de la réduction à l'automatisation pour tous les envois figurant sur le manifeste.
options-and-surcharges	Simple	(Champ numérique de six chiffres, suivis de deux décimales [p. ex. format 999999.99]) Fait partie de manifest-pricing-info. Il s'agit du total pour les options et les suppléments pour tous les envois figurant sur le manifeste.
gst	Simple	(Champ numérique de six chiffres, suivis de deux décimales [p. ex. format 999999.99]) Fait partie de manifest-pricing-info. Il s'agit du total de la TPS pour tous les envois figurant sur le manifeste.
pst	Simple	(Champ numérique de six chiffres, suivis de deux décimales [p. ex. format 999999.99]) Fait partie de manifest-pricing-info. Il s'agit du total de la TVP pour tous les envois figurant sur le manifeste.
hst	Simple	(Champ numérique de six chiffres, suivis de deux décimales [p. ex. format 999999.99]) Fait partie de manifest-pricing-info. Il s'agit du total de la TVH pour tous les envois figurant sur le manifeste.
total-due-cpc	Simple	(Champ numérique de six chiffres, suivis de deux décimales [p. ex. format 999999.99]) Fait partie de manifest-pricing-info. Il s'agit du total dû à Postes Canada pour tous les envois figurant sur le manifeste.
manifest-address	Les éléments dans manifest-address sont identiques aux éléments décrits dans manifest-address dans les éléments de réponse de la demande de service Transmettre les envois. Les voici : manifest-name, address-details, address-line-1, address-line-2, city, prov-state, country-code and postal-zip-code.

Réponse – Diagramme XML

Obtenir les détails du manifeste – Structure de niveau supérieur de la réponse XML

Voir l'image en taille réelle

Réponse – Réponses d'erreur possibles

Aucune erreur nest prévue pour lutilisation de ce lien, mais vous apercevrez une erreur 404 si vous utilisez le service Obtenir les détails du manifeste plus de 90 jours après que le lien a été fourni ou si vous lutilisez pour obtenir un manifeste vide (consultez la page Transmettre les envois pour obtenir plus de détails).

Veuillez consulter la section Codes de statut HTTP pour obtenir de plus amples renseignements.

Exemples

Exemple de demande REST – Obtenir les détails du manifeste


  GET https://XX/rs/0001234567/0001234567/manifest/123456789012345678/details

    Accept:application/vnd.cpc.manifest-v8+xml

    Authorization:345j34j3j34k=435==

Exemple de réponse XML – Obtenir les détails du manifeste


  
  
 <manifest-details>

     <po-number>D906367941</po-number>

      <final-shipping-point>K1G1C0</final-shipping-point>

      <shipping-point-name>OTTAWA T PO</shipping-point-name>

      <shipping-point-id>0015</shipping-point-id>

      <mailed-by-customer>0001234567</mailed-by-customer>

      <mailed-on-behalf-of>0001234567</mailed-on-behalf-of>

      <paid-by-customer>0001234567</paid-by-customer>

      <manifest-date>2011-09-01</manifest-date>

      <manifest-time>16:42 EDT</manifest-time>

      <contract-id>0012345678</contract-id>

      <method-of-payment>account</method-of-payment>

      
      <manifest-pricing-info>

       <base-cost>39.57</base-cost>

        <automation-discount>0</automation-discount>

        <options-and-surcharges>26.37</options-and-surcharges>

        <gst>0.00</gst>

        <pst>0</pst>

        <hst>8.58</hst>

        <total-due-cpc>74.52</total-due-cpc>

      
      </manifest-pricing-info>

      <manifest-address>

       <manifest-name>MajorShop</manifest-name>

        <phone-number>514 829 5879</phone-number>

        <address-details>

         <address-line-1>1230 Tako RD.</address-line-1>

          <city>Ottawa</city>

          <prov-state>ON</prov-state>

          <country-code>CA</country-code>

        
        </address-details>

      
      </manifest-address>

    
    </manifest-details>

Ouvrir unesession