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)

YYYY-MM-DD

les dates de début et de fin

{numéro de référence}

la valeur que vous avez spécifié dans les champs customer-ref-1 ou customer-ref-2 lorsque vous avez créé l'envoi.

{numéro du client}

le numéro du client

{code postal de destination}

le code postal de destination du colis

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

Accès avec le numéro d'identification du produit (NIP)

{pin number}

Intégré directement
à l'URI

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é à l'URI comme suit :

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

Accès avec le numéro de la CAL

{dnc number}

Intégré directement
à l'URI

Numéro de la carte Avis de livraison (CAL) : Le numéro sur la carte laissé 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é à l'URI comme suit :

XX/vis/track/dnc/{Numéro de la carte Avis de livraison}/summary.

Accès avec les paramètres de référence

customerNumber=XXXX

QParamètre de requête (facultatif)

La valeur du paramètre de requête du customerNumber peut être :

• le numéro du client pour l'organisation qui entreprend l'expédition;
• le numéro du client pour le client au nom duquel le colis a été expédié.

(10 caractères numériques)

Il s'agit d'un paramètre de requête facultatif. Si le paramètre de requête pour le customerNumber n'est pas précisé, le customer-number de l'utilisateur qui a été utilisé pour authentifier cette demande sera utilisé.

Si vous expédiez des colis au nom d'autres clients et que vous précisez leur numéro de client dans la demande, seuls les résultats de repérage des colis qui ont été expédiés au nom de ce client (et qui correspondent aux autres critères des paramètres de requête) sont renvoyés.

Si vous expédiez des colis au nom d'autres clients et que vous précisez votre propre numéro de client, vous recevrez des résultats de repérage pour tous les colis que vous avez expédiés vous-même, y compris tous les colis que vous avez expédiés au nom d'autres clients (à condition qu'ils correspondent aux autres critères des paramètres de requête).

reference
Number=XXXX

Paramètre de requête (obligatoire)

La valeur attribuée à un colis par l'expéditeur lorsque l'envoi a été créé. Cette valeur peut avoir été indiquée dans les champs « customer-ref1 » ou « customer-ref2 » du colis soumis.

(jusqu'à 35 caractères)

Lorsque vous exécutez une demande avec le paramètre de référence, le paramètre de requête du referenceNumber est obligatoire et doit être inclus.

Le service Obtenir un résumé de repérage fournit seulement les résultats du repérage pour les colis qui correspondent à la valeur du paramètre de requête referenceNumber.

destinationPostalCode=XXXX

Paramètre de requête (facultatif)

Le code postal de destination, le code ZIP ou l'identificateur postal du colis dans son pays de destination. Il s'agit de la valeur qui serait fournie dans l'élément « postal-zip-code » dans une demande de création d'un envoi.

Le format est l'un des suivants :

• six caractères alphanumériques pour le Canada
  (A9A9A9)
• code numérique de cinq chiffres ou de cinq chiffres avec un tiret et quatre chiffres supplémentaires pour les É.-U.
  (99999 or 99999-9999)
• chaîne de caractères – jusqu'à 14 caractères (tout format) pour les autres pays.

Le paramètre de requête destinationPostalCode est facultatif.

Lorsqu'il est offert, le service Obtenir un résumé de repérage fournit seulement les résultats du repérage pour les colis qui correspondent à la valeur du paramètre de requête destinationPostalCode.

Nota : Pour les codes ZIP dont le format est « 99999-9999 », seulement les cinq premiers caractères sont utilisés dans la mise en correspondance.

mailingDateFrom=
YYYY-MM-DD

Paramètre de requête (obligatoire)

La combinaison des paramètres de requête mailingDateFrom et mailingDateTo définit une plage de dates pendant laquelle les colis en question ont été expédiés.

Le format est : aaaa-mm-jj.

La valeur mailingDateFrom ne peut pas être antérieure à deux mois civils à partir de la date actuelle.

Lorsque vous exécutez une demande avec un paramètre de référence, les paramètres de requête mailingDateFrom et mailingDateTo sont obligatoires et doivent être inclus.

Le service Obtenir un résumé de repérage fournit seulement les résultats du repérage pour les colis qui ont été expédiés à l'intérieur de la plage de dates précisées par les paramètres de requête mailingDateFrom et mailingDateTo.

mailingDateTo=
YYYY-MM-DD

Paramètre de requête (obligatoire)

tracking-summary

Niveau supérieur de la structure XML

pin-summary

Contient la réponse pour le NIP précis.

Fait partie de l'élément <tracking-summary>.

pin

(15 caractères numériques)

Numéro d'identification du colis (NIP) pouvant être utilisé par le client pour faire appel aux services de repérage.

origin-postal-id

Trois premiers caractères du code postal d'origine pour les destinations canadiennes.

^[ABCEGHJKLMNPRSTVXY]{1}\d{1}[A-Z]{1}

Dans le cas d'un colis d'arrivée du régime international, ce champ est vide ou il contient l'identificateur postal du pays d'origine.

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 un identificateur du pays de destination.

destination-province

Code de province à deux caractères pour la destination.

« indicateurs postaux » – abréviations utilisées par Postes Canada (ISO 3166-2) pour les colis du régime intérieur.

Les colis à destination des É.-U. et du régime international portent l'identificateur postal du pays de destination (p. ex., le code ZIP pour les colis à destination des É.-U.).

service-name

Nom du service de Postes Canada dans la langue précisée. 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 nom du service est vide ou il contient le nom du service fourni par l'expéditeur d'origine, le cas échéant.

mailed-on-date

aaaa-mm-jj

Date de la première activité pour l'article. Si l'article a été expédié à partir d'une destination internationale, cette date peut ne pas être indiquée.

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.

actual-delivery-date

aaaa-mm-jj

Date à laquelle l'article a été livré.

N'apparaît pas si l'article n'a pas été livré ou si les données de livraison provenant d'un organisme international n'ont pas été fournies pour un envoi du régime international.

delivery-option-completed-ind

0 – Au moins une option n'a pas été satisfaite

1 – toutes les options ont été satisfaites

2 – aucune option n'a été trouvée

event-date-time

aaaammjj :hhmmss

Horodatage de l'activité la plus récente ou la plus importante.

event-description

Brève description de l'activité.

attempted-date

aaaa-mm-jj – Date à laquelle une tentative de livraison à été effectuée.

Pour les articles envoyés au Canada ou les articles du régime intérieur, il sera indiqué qu'une tentative infructueuse de livraison a été effectuée à la date précisée.

customer-ref-1

(chaîne de caractères jusqu'à 35 caractères)

Valeur fournie par l'expéditeur (customer-ref-1) lorsque l'envoi a d'abord été créé auprès de Postes Canada. L'ensemble de caractères en français est appuyé par cette interface.

customer-ref-2

(chaîne de caractères jusqu'à 35 caractères)

Valeur fournie par l'expéditeur (customer-ref-2) lorsque l'envoi a d'abord été créé auprès de Postes Canada. L'ensemble de caractères en français est appuyé par cette interface.

return-pin

Si une étiquette Service de retour (NIP) a été imprimée en même temps que l'envoi a été créé et que l'envoi est retourné, le NIP de retour est affiché.

event-type

Valeur dans ce champ qui montre quel type d'activité est indiqué pour cet article.

event-location

Pour une activité correspondant à un balayage ou à une livraison, cette valeur indiquera l'emplacement où l'activité a eu lieu.

signatory-name

Si l'événement indiqué comme la dernière activité la plus importante est une signature, le texte de ce champ renferme le 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.

code

ID relatif à l'échec d'une recherche.

description

Message textuel relatif au code d'usager.

002

NIP en double

Reçu pour les recherches de NIP ou de CAL lorsque des NIP en double ont été constatés.

004

Aucun historique pour le NIP

Aucun résultat de repérage obtenu d’après les paramètres fournis. Vérifiez les paramètres et l’ordre des dates d’expédition et de destination.

006

Champs du numéro de référence, de la date d'expédition et du code postal de destination qui sont requis pour effectuer une recherche du numéro de référence.

Reçu seulement pour les recherches de numéro de référence.

008

Date invalide

Pour les recherches du numéro de référence des résumés, les dates de plus de deux mois entraîneront une répétition de l'erreur.