Pour récupérer les renseignements liés à un envoi créé précédemment. Il pourrait s'avérer utile pour la récupération de données d'une communication ou d'une autre erreur ou la production de rapports concernant tous les envois en attente.

Nota : Tous les envois qui sont transmis (p. ex. faisant partie d'une transmission réussie) ne seront pas accessibles pour ce service.

Numéros d'identification pour les renseignements associés à l'envoi créé, y compris le numéro d'identification de l'envoi, les numéros d'identification du produit (NIP) pour le repérage et les numéros d'identification de l'artefact pour accéder aux étiquettes.

Vous pourrez accéder à ces numéros d'identification pendant 90 jours ou jusqu'à ce que vous annuliez l'envoi.

Notes de mise à jour

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

shipment-id

simple

requis

(Chaîne alphanumérique – Jusqu'à 32 lettres/chiffres)

Numéro d'identification représentant l'envoi existant pour lequel les renseignements sont demandés.

Nota : Il faut récupérer le numéro d'identification de l'envoi fourni dans le cadre des demandes de service précédentes « Créer l'envoi » et « Obtenir l'envoi ». Les données de sortie de ces services comprendront un numéro d'identification pour l'envoi.

get-shipment-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'un message d'erreur.

shipment-info

complexe

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

customer-request-id

simple

Votre code de transaction unique, si vous l’avez indiqué dans votre demande.

shipment-id

simple

Il s'agit d'un numéro d'identification unique pour l'envoi. Il est utilisé pour toutes les autres demandes de service connexes.

shipment-status

simple

Indique l'état actuel de l'envoi. Les valeurs valides sont les suivantes :

• Créé
• Transmis
• Suspendu

tracking-pin

simple

NIP de repérage pour l'envoi. Il peut être utilisé en tant que donnée d'entrée pour toute autre demande de service pour les colis, notamment le service « Obtenir les détails de repérage ».

return-tracking-pin

simple

NIP de repérage pour l'envoi retourné. Il peut être utilisé en tant que donnée d'entrée pour toute autre demande de service pour les colis, notamment le service « Obtenir les détails de repérage ».

group-id

simple

Nom du groupe dans lequel l'envoi a été créé. Le nom du groupe est unique dans le domaine du client « Expédié au nom de ».

artifacts

complexe

Structure contenant les renseignements vous permettant d'accéder aux diverses étiquettes (artefacts) pour l'envoi.

Vous pouvez récupérer les étiquettes à l'aide de ces renseignements et du service « Obtenir l'artefact ».

artifact

complexe

Représente une étiquette (artefact) individuelle pour l'envoi.

Occurrence (1 à N fois).

Cet élément inclura le type d'attribut « XXX »
correspondant au type d'étiquette représenté par cet artefact.

Voici les quatre valeurs possibles pour cet attribut associé à quatre types d'étiquettes :

• "label" – Étiquette d'expédition principale
• "returnLabel" – Étiquette pour la livraison d'un envoi retourné
• "codRemittanceLabel" – Étiquette pour le paiement CR
• "codRemittanceReturnLabel" – Étiquette utilisée lorsque le système doit afficher un paiement CR

artifact-id

simple

Représente un numéro d'identification unique pour l'étiquette (artefact) requis dans le cadre de la demande de service « Obtenir l'artefact » pour récupérer l'étiquette.

page-index

simple

Nota : Cet élément est toujours zéro pour le PDF étant donné que ce dernier appuie plusieurs pages. Il n'est pas requis dans les demandes de récupération des documents PDF.