get-tracking-summary-request

complexe

requis

Élément XML de niveau supérieur de la structure de la réponse.

Nota : Il doit y avoir exactement un NIP, un numéro de CAL ou un critère de référence pour cet élément de niveau supérieur.

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 fournie, la langue par défaut est « Anglais ».

pin-number

simple

requis sous condition

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.

dnc-number

simple

requis sous condition

Numéro de la carte Avis de livraison (CAL) : Il s'agit du numéro figurant 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.

reference-criteria

complexe

requis sous condition

Cette structure contient les paramètres de référence pour une demande de service.

customer-number

simple

optionnel

Il peut s'agir :

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

(10 caractères numériques)

Il s'agit d'un élément optionnel. Si le numéro de client n'est pas précisé, le numéro de client de l'utilisateur servant à 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 de votre demande) s'affichent.

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 de votre demande).

reference-number

simple

requis sous condition

Il s'agit de la valeur attribuée à un colis par l'expéditeur lorsque l'envoi a été créé. Vous auriez précisé cette valeur dans le champ « customer-ref-1 » ou « customer-ref-2 » du colis soumis.

(Jusqu'à 35 caractères)

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

Le service « Obtenir le résumé du repérage » fournit seulement les résultats du repérage pour les colis correspondant à la valeur du numéro de référence.

destination-postal-code

simple

optionnel

Code postal de destination, code ZIP ou identificateur postal du colis dans son pays de destination. Il s'agit de la valeur qui serait fournie pour 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, suivi d'un tiret et de quatre chiffres supplémentaires pour les É.-U.
  (99999 ou 99999-9999)
• chaîne de caractères – Jusqu'à 14 caractères (tout format) pour les autres pays.

Le code postal de destination est optionnel.

Lorsqu'il est offert, le service « Obtenir un résumé du repérage » fournit seulement les résultats du repérage pour les colis correspondant à la valeur du code postal de destination.

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.

mailing-date-from

simple

requis sous condition

La combinaison des dates de début et de fin 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 « mailing-date-from » 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 dates de début et de fin de l'expédition sont obligatoires et doivent être incluses.

Le service « Obtenir un résumé du repérage » fournit seulement les résultats pour les colis expédiés à l'intérieur de la plage de dates précisée à l'aide des dates de début et de fin de l'expédition.

mailing-date-to

simple

requis sous condition

get-tracking-summary-response

Niveau supérieur de la structure XML pour la réponse.

Il affichera les résultats d'une exécution réussie ou la structure d'un message d'erreur.

tracking-summary

Structure principale contenant les résultats de la demande.

pin-summary

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

Occurrence 1 à 100 fois.

Nota : Les requêtes liées aux NIP et aux numéros de CAL afficheront un seul résultat, soit un résumé des NIP. Une recherche du numéro de référence peut donner de multiples résultats concernant le résumé des NIP si plus d'un article satisfait aux critères de recherche.

pin

Numéro d'identification du produit (NIP) pouvant être utilisé pour présenter une demande de service de repérage.

origin-postal-id

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

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.

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 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 nom du service 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

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

Il s'agit de la 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

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

Date de la tentative de livraison.

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

Il s'agit de la valeur fournie par l'expéditeur (référence du client 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

Il s'agit de la valeur fournie par l'expéditeur (référence du client 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 du 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

La valeur dans ce champ désignera le type d'activité représenté 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.

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.