• Pour récupérer les numéros d'identification propres à un groupe d'envois n'ayant pas encore été transmis (membres d'un groupe)
• Pour récupérer les numéros d'identification propres à un groupe d'envois ayant été transmis (membres d'un manifeste)
• Pour récupérer une liste des envois pour lesquels un manifeste n'est pas requis

Mailed-by, locale (optionnel) et un des éléments suivants :

• group-id
• manifest-id
• no-manifest

Liste de numéros d'identification pour les envois

Demandes facultatives suivantes : Obtenir le tarif de l’envoi, Obtenir les détails de l’envoi, Obtenir le reçu de l’envoi, Rembourser l’envoi

Notes de mise à jour

get-shipments-request

complexe

requis

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

mailed-by

simple

requis

(1 à 10 caractères numériques)

Il s'agit du numéro de client à 10 chiffres du client « Expédié par ».

Si le numéro fourni compte moins de 10 chiffres, le système ajoutera des zéros au début.

mobo

simple

optionnel

(1 à 10 caractères numériques)

Il s'agit du numéro de client à 10 chiffres du client « Expédié au nom de ».

S'il manque cet élément, le numéro du client « Expédié par » s'affichera par défaut.

Si le numéro fourni compte moins de 10 chiffres, le système ajoutera des zéros au début.

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 ».

platform-id

simple

optionnel

Votre numéro de client (pour plateformes de cybercommerce uniquement)

provide-shipment-info

simple

optionnel

Réservé pour l'usage interne.

shipment-search-key

complexe

requis

Comprend soit la structure de l'élément regular-shipping-parameters ou l'élément no-manifest-shipping-parameters (pour une recherche d'envois où aucun manifeste n'est requis comme preuve de paiement).

Seul l'un des éléments doit être fourni (regular-shipping-parameters, no-manifest-shipping-parameters, tracking-pin ou customer-request-id).

regular-shipping-parameters

complexe

requis sous condition

Contient l'élément clé (« group-id » ou « manifest-id ») qui sera utilisé pour trouver les envois correspondants.

Option s'excluant mutuellement avec les éléments no-manifest-shipping-parameters, tracking-pin et customer-request-id.

group-id

simple

requis sous condition

(Chaîne de caractères – Jusqu'à 32 caractères)

Numéro d'identification du groupe pour lequel les envois doivent être retournés.

Cet élément est requis si vous voulez obtenir la liste d'envois non transmis dans un groupe.

Remarque : Seul l'un des éléments enfants de regular-shipping-parameters doit être fourni.

manifest-id

simple

requis sous condition

(Chaîne de caractères – Jusqu'à 32 caractères)

Numéro d'identification du manifeste existant pour lequel les renseignements sont demandés.

Il faut récupérer l'élément manifest-id fourni dans le cadre des demandes de service précédentes « Transmettre les envois » et « Obtenir les manifestes ». Les données de sortie de ces services comprendront un numéro d'identification pour le manifeste.)

Nota : Un des deux éléments (« group-id » ou « manifest-id ») doit être présent, mais jamais les deux.

no-manifest-shipping-parameters

complexe

requis sous condition

Contient la clé de recherche (no-manifest) qui sera utilisée pour rechercher les envois pour lesquels un manifeste n'est pas requis.

Option s'excluant mutuellement avec les éléments regular-shipping-parameters, tracking-pin et customer-request-id.

no-manifest

complexe

requis sous condition

{true}

Lorsqu'il est réglé à « true », cet élément indique que vous désirez rechercher une liste d'envois pour lesquels un manifeste n'est pas requis.

Nota : Si la structure de l'élément no-manifest-shipping-parameters est présente, cet élément est alors requis.

date

simple

optionnel

La date à partir de laquelle vous voulez que la recherche commence pour les envois pour lesquels un manifeste n'est pas requis. La date du jour s'affiche par défaut si l'élément n'est pas présent. Format : AAAAMMJJ

limit

simple

optionnel

(1 à 5 caractères numériques)

Le nombre maximal d'envois pour lesquels un manifeste n'est pas requis que vous désirez recevoir dans la réponse. Le nombre par défaut est « 100 » si l'élément n'est pas présent.

Valeur maximale = 99999

tracking-pin

simple

Requis sous condition

(Chaîne alphanumérique – 11 à 16 lettres/chiffres)
NIP de repérage de l'envoi existant pour lequel les renseignements sont demandés.

Remarque : Comme les envois de Petits paquets n'ont pas de NIP de repérage, vous devez les chercher à l'aide des autres paramètres de recherche.

Option s'excluant mutuellement avec les éléments regular-shipping-parameters et no-manifest-shipping-parameters, no-manifest-shipping-parameters et customer-request-id.

Remarque : Dans l'environnement (de développement) « Bac à sable », le même NIP de repérage est toujours retourné (123456789012); alors, cette requête ne retournera pas des résultats représentatifs dans cet environnement.

customer-request-id

simple

Requis sous condition

(Chaîne alphanumérique – jusqu’à 32 lettres/caractères)

Le numéro de demande du client associé à l’envoi pour lequel des renseignements sont demandés.

Ces éléments sont mutuellement exclusifs avec les paramètres « regular-shipping-parameters », « no-manifest-shipping-parameters » et « tracking-pin ».

get-shipments- response

Complexe

Il s'agit de l'élément XML de niveau supérieur de la structure de la réponse.

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

shipments

Complexe

Structure XML contenant les résultats liés à l'exécution réussie du service en question.

shipment-id

Simple

Ces éléments sont mutuellement exclusifs avec le paramètre « shipment-info » et ne sont pas fournis lorsque le paramètre « provide-shipment-info = true » est fourni.

Occurrence (0 à N fois).

Numéro d'identification unique pour l'envoi pouvant être utilisé pour la demande de service future
« Obtenir l'envoi » ou pour les autres demandes de service futures afin d'obtenir plus de détails
sur l'envoi.

shipment-info

Complexe

Réservé pour l'usage interne.