Programme pour développeurs

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

Ressources

Repérage

Exemples de codes de repérage : Java (.zip) | PHP (.zip) | C# (.zip)

Obtenir les détails de repérage – Module REST

Résumé

Nom :	Obtenir les détails de repérage
Raison pour utiliser le service :	Connaître toutes les activités de repérage pour un seul colis
Données d'entrée :	NIP/Numéro de CAL
Données de sortie :	Renseignements de base sur les colis, dates, emplacement et statut pour chaque événement et renseignements sommaires sur les colis.
Exemples d'erreurs :	Aucun historique pour le NIP
Demandes de service précédentes possibles :	Obtenir un résumé du repérage
Possible Next Calls:	Obtenir l'image de la signature et Obtenir le certificat de confirmation de livraison
Historique des versions :	Notes de mise à jour

Détails sur la demande

Structure de la demande pour obtenir les détails de repérage

Point final

GET https://XX/vis/track/pin/{numéro d'identification du produit}/detail ou GET https://XX/vis/track/dnc/{numéro de la carte Avis de livraison}/detail
Remplacez...	Par...
XX (développement)	ct.soa-gw.canadapost.ca
XX (production)	soa-gw.canadapost.ca
{numéro d'identification du produit}	le numéro d'identification du produit (NIP)
{numéro de la carte Avis de livraison}	le numéro de la carte Avis de livraison (CAL)

En-têtes HTTP

Variable des en-têtes HTTP	Valeur
Accept	application/vnd.cpc.track-v2+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

Le tableau suivant décrit les deux paramètres possibles utilisés pour repérer le colis pour lequel l'information est demandée.

Obtenir les détails de repérage – REST – Paramètres de la demande

Nom du paramètre Description/taille/format

Obtenir les détails de repérage – REST – Paramètres de la demande
Nom du paramètre	Description/taille/format
{pin number}	Le numéro d'identification du produit (NIP) est attribué par Postes Canada au cours de la création de l'étiquette d'expédition et utilisé aux fins de repérage. (12, 13 ou 16 caractères) Lorsque vous exécutez une demande avec le NIP, il est obligatoire et il s'agit du seul paramètre nécessaire. Le {numéro d'identification du produit} est intégré au URI comme suit : `XX/vis/track/pin/{numéro d'identification du produit}/detail`
dnc	Numéro de la carte Avis de livraison (CAL) : Le numéro sur la carte laissée par le personnel de livraison lorsqu'il n'y a personne à la maison pour recevoir la livraison. (15 caractères numériques) Lorsque vous exécutez une demande avec le numéro de la CAL, il est obligatoire et il s'agit du seul paramètre nécessaire. Le {numéro de la carte Avis de livraison} est intégré aux URI comme suit : `XX/vis/track/dnc/{numéro de la carte Avis de livraison}/detail`

{pin number}

Le numéro d'identification du produit (NIP) est attribué par Postes Canada au cours de la création de l'étiquette d'expédition et utilisé aux fins de repérage.

(12, 13 ou 16 caractères)

Lorsque vous exécutez une demande avec le NIP, il est obligatoire et il s'agit du seul paramètre nécessaire.

Le {numéro d'identification du produit} est intégré au URI comme suit :

XX/vis/track/pin/{numéro d'identification du produit}/detail

dnc

Numéro de la carte Avis de livraison (CAL) : Le numéro sur la carte laissée par le personnel de livraison lorsqu'il n'y a personne à la maison pour recevoir la livraison.

(15 caractères numériques)

Lorsque vous exécutez une demande avec le numéro de la CAL, il est obligatoire et il s'agit du seul paramètre nécessaire.

Le {numéro de la carte Avis de livraison} est intégré aux URI comme suit :

XX/vis/track/dnc/{numéro de la carte Avis de livraison}/detail

Détails de la réponse

Éléments de réponse

Obtenir les détails de repérage – REST – Aperçu détaillé des éléments de réponse
Nom du champ	Description
tracking-detail	Niveau supérieur de la structure XML.
pin	NIP pouvant être utilisé pour les autres demandes de repérage .
active-exists	1 \| 0 La mention "1" signifie que les données de repérage figurent dans la base de données actives.
archive-exists	1 \| 0 La mention "1" signifie que les données de repérage figurent dans la base de données archivées.
destination-postal-id	Trois premiers caractères du code postal de destination pour les colis qui doivent être livrés au Canada. `^[ABCEGHJKLMNPRSTVXY]{1}\d{1}[A-Z]{1}` Pour les colis du régime international, il s'agit de l'identificateur postal du pays de destination (p. ex. le code ZIP pour les colis à destination des É.-U.) ou de l'identificateur du pays de destination.
expected-delivery-date	aaaa-mm-jj Date à laquelle l'article doit arriver à l'adresse de destination pour les adresses au Canada. Si l'article a été expédié à destination ou en provenance de l'étranger, cette date peut ne pas être indiquée.
changed-expected-date	aaaa-mm-jj Il s'agit de la nouvelle date de livraison prévue.
changed-expected-delivery-reason	Description du texte pour la raison du changement de la date de livraison prévue.
mailed-by-customer-number	Numéro de client de l'expéditeur.
mailed-on-behalf-of-customer-number	Numéro du client (expédié au nom de), le cas échéant.
original-pin	Si un colis est retourné et que le colis initial a été créé avec une étiquette Service de retour prévu, ce champ contiendra le NIP initial lorsque le NIP de retour est demandé.
service-name	Nom du service de Postes Canada dans la langue précisée par la demande. (Le service-name sera indiqué par défaut en anglais si la langue n'est pas précisée.) Pour les colis d'arrivée du régime international, le champ relatif au type du service est vide ou il contient le nom du service fourni par l'expéditeur d'origine, le cas échéant.
service-name-2	Nom du service de Postes Canada dans l'autre langue officielle du Canada. Pour les colis d'arrivée du régime international, le champ relatif au nom du service est vide ou il contient le nom du service fourni par l'expéditeur d'origine.
customer-ref-1	Valeur fournie par l'expéditeur (référence du client 1) lorsque l'envoi a d'abord été créé par Postes Canada. Il faut éviter d'utiliser des caractères spéciaux en saisissant les numéros de référence des clients.
customer-ref-2	Valeur fournie par l'expéditeur (référence du client 2) lorsque l'envoi a d'abord été créé par Postes Canada. Il faut éviter d'utiliser des caractères spéciaux en saisissant les numéros de référence des clients.
return-pin	Si un colis est envoyé avec une étiquette Service de retour prévu, ce champ contiendra le NIP de retour lorsque le NIP initial est demandé.
signature-image-exists	vrai \| faux Vrai : L'option « Obtenir l'image de la signature » affichera l'image de la signature. Faux : Il n'est pas nécessaire de sélectionner l'option « Obtenir l'image de la signature » puisque le système indiquera qu'aucune image n'est trouvée.
suppress-signature	vrai \| faux Indique si le destinataire du colis a demandé de supprimer l'image de sa signature recueillie par Postes Canada pour les colis du régime intérieur afin qu'elle ne puisse pas être visualisée par d'autres.
delivery-options	Série d'options de livraison demandées pour ce colis.
delivery-option	La chaîne représente l'option de livraison.
delivery-option-description	Description de l'option de livraison.
significant-events	Liste d'activités associées au colis.
occurrence	L'élément parent est un ensemble de renseignements importants sur un événement.
event-identifier	Identificateur de l'activité utilisé pour définir les types d'activités.
event-date	aaaa-mm-jj – Date de l'activité de repérage .
event-time	hh:mm:ss – Heure de l'activité de repérage .
event-time-zone	Fuseau horaire associé à l'activité. Il pourrait ne pas être défini pour les activités de repérage à l'échelle internationale.
event-description	Brève description de l'activité.
signatory-name	Si l'activité présentée est une activité de saisie de la signature, le texte de ce champ correspondra au nom du signataire. Remarque : Pour une protection accrue de la vie privée et de la sécurité, le champ du nom du signataire sera dorénavant toujours vide. Il pourrait être retiré dans une version future.
event-site	Renseignements sur l'emplacement fournis par le préposé au service de colis.
event-province	Pour les activités du régime intérieur, il contient la province où l'activité a eu lieu.
event-retail-location-id	Contient l'office-id lorsqu'un colis est retenu ou qu'il a été retenu.
event-retail-name	Nom du comptoir postal où le colis est retenu.
cod-remit-info	Renseignements associant un colis CR à une activité de repérage du paiement ou vice versa.
pin	Dans ce cas, il s'agit du NIP d'un paiement CR ou du colis initial selon la valeur du type.
type	Valeur de « COD_PIN » ou de « REMIT_PIN ». Il indique le NIP correspondant à la valeur susmentionnée.
id	Code associé à l'échec de la requête.
description	Message textuel lié au code.

Réponses d'erreur possibles

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

Code	Description
004	Aucun historique pour le NIP
002	NIP en double

Diagramme XML de la réponse

Diagramme XML de la réponse à la demande Obtenir les détails de repérage

Voir l'image en taille réelle

Exemples

Demande de détails liés aux NIP


  GET https://XX/vis/track/pin/7023210039414604/detail

Réponse concernant les détails liés aux NIP


  
  
 <tracking-detail>

     <pin>7023210039414604</pin>

      <active-exists>1</active-exists>

      <archive-exists/>

      <changed-expected-date/>

      <destination-postal-id>K0J1T0</destination-postal-id>

      <duplicate-flag-ind/>

      <expected-delivery-date>2011-04-05</expected-delivery-date>

      <changed-expected-delivery-reason/>

      <mailed-by-customer-number>0007023210</mailed-by-customer-number>

      <mailed-on-behalf-of-customer-number>0007023210</mailed-on-behalf-of-customer-number>

      <original-pin/>

      <service-name>Expedited  Parcels</service-type>

      <service-name-2>Colis  acc&#233;l&#233;r&#233;s</service-name-2>

      <customer-ref-1>APRIL1REF1A</customer-ref-1>

      <customer-ref-2>APRIL1REF1C</customer-ref-2>

      <return-pin/>

      <signature-image-exists>false</signature-image-exists>

      <suppress-signature>false</suppress-signature>

      <delivery-options>

       <item>

         <delivery-option>CH_HLD_PCK_UP</delivery-option>

          <delivery-option-description>Card  for Pickup</delivery-option-description>

        
        </item>

        <item>

         <delivery-option>CH_SGN_OPTION</delivery-option>

          <delivery-option-description>Signature  Required</delivery-option-description>

        
        </item>

        <item>

         <delivery-option>CH_SGN_OPTION</delivery-option>

          <delivery-option-description>Proof  of Age Required</delivery-option-description>

        
        </item>

        <item>

         <delivery-option>CH_COD_VALUE</delivery-option>

          <delivery-option-description>COD  Amount</delivery-option-description>

        
        </item>

      
      </delivery-options>

      <significant-events>

       <item>

         <event-identifier>3000</event-identifier>

          <event-date>2011-04-04</event-date>

          <event-time>13:34:57</event-time>

          <event-time-zone>EST</event-time-zone>

          <event-description>Order  information received by Canada Post</event-description>

          <signatory-name/>

          <event-site>OTTAWA</event-site>

          <event-province>ON</event-province>

          <event-retail-location-id/>

          <event-retail-name/>

        
        </item>

      
      </significant-events>

    
    </tracking-detail>

Demande de détails liés à la CAL


  GET https://XX/vis/track/dnc/315052413796541/detail

Réponse concernant les détails liés à la CAL


  
  
 <tracking-detail>

     <pin>1371134583769923</pin>

      <active-exists>1</active-exists>

      <archive-exists></archive-exists>

      <changed-expected-date>2011-02-11</changed-expected-date>

      <destination-postal-id>G1K4M7</destination-postal-id>

      <expected-delivery-date>2011-02-01</expected-delivery-date>

      <changed-expected-delivery-reason>Customer addressing error found; attempting to correct</changed-expected-delivery-reason>

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

      <mailed-on-behalf-of-customer-number>0008765432</mailed-on-behalf-of-customer-number>

      <original-pin></original-pin>

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

      <service-name-2>Xpresspost</service-name-2>

      <customer-ref-1>955-0398</customer-ref-1>

      <customer-ref-2></customer-ref-2>

      <return-pin></return-pin>

      <signature-image-exists>true</signature-image-exists>

      <suppress-signature>false</suppress-signature>

      <delivery-options>

       <item>

         <delivery-option>CH_SGN_OPTION</delivery-option>

          <delivery-option-description>Signature Required</delivery-option-description>

        
        </item>

      
      </delivery-options>

      <significant-events>

       <occurrence>

         <event-identifier>20</event-identifier>

          <event-date>2011-02-03</event-date>

          <event-time>11:59:59</event-time>

          <event-time-zone>EST</event-time-zone>

          <event-description>Signature image recorded for Online viewing</event-description>

          <signatory-name>HETU</signatory-name>

          <event-site>SAINTE-FOY</event-site>

          <event-province>QC</event-province>

          <event-retail-location-id></event-retail-location-id>

          <event-retail-name></event-retail-name>

        
        </occurrence>

        <occurrence>

         <event-identifier>0174</event-identifier>

          <event-date>2011-02-03</event-date>

          <event-time>08:27:43</event-time>

          <event-time-zone>EST</event-time-zone>

          <event-description>Item out for delivery</event-description>

          <signatory-name></signatory-name>

          <event-site>SAINTE-FOY</event-site>

          <event-province>QC</event-province>

          <event-retail-location-id></event-retail-location-id>

          <event-retail-name></event-retail-name>

        
        </occurrence>

        <occurrence>

         <event-identifier>0100</event-identifier>

          <event-date>2011-02-02</event-date>

          <event-time>14:45:48</event-time>

          <event-time-zone>EST</event-time-zone>

          <event-description>Item processed at postal facility</event-description>

          <signatory-name></signatory-name>

          <event-site>QUEBEC</event-site>

          <event-province>QC</event-province>

          <event-retail-location-id></event-retail-location-id>

          <event-retail-name></event-retail-name>

        
        </occurrence>

        <occurrence>

         <event-identifier>0173</event-identifier>

          <event-date>2011-02-02</event-date>

          <event-time>06:19:57</event-time>

          <event-time-zone>EST</event-time-zone>

          <event-description>Customer addressing error found; attempting to correct. Possible delay</event-description>

          <signatory-name></signatory-name>

          <event-site>QUEBEC</event-site>

          <event-province>QC</event-province>

          <event-retail-location-id></event-retail-location-id>

          <event-retail-name></event-retail-name>

        
        </occurrence>

        <occurrence>

         <event-identifier>1496</event-identifier>

          <event-date>2011-02-01</event-date>

          <event-time>07:59:52</event-time>

          <event-time-zone>EST</event-time-zone>

          <event-description>Item successfully delivered</event-description>

          <signatory-name></signatory-name>

          <event-site>QUEBEC</event-site>

          <event-province>QC</event-province>

          <event-retail-location-id></event-retail-location-id>

          <event-retail-name></event-retail-name>

        
        </occurrence>

        <occurrence>

         <event-identifier>20</event-identifier>

          <event-date>2011-02-01</event-date>

          <event-time>07:59:52</event-time>

          <event-time-zone>EST</event-time-zone>

          <event-description>Signature image recorded for Online viewing</event-description>

          <signatory-name>R GREGOIRE</signatory-name>

          <event-site>QUEBEC</event-site>

          <event-province>QC</event-province>

          <event-retail-location-id></event-retail-location-id>

          <event-retail-name></event-retail-name>

        
        </occurrence>

      
      </significant-events>

    
    </tracking-detail>

Ouvrir unesession