Expédition
Obtenir l'artefact – Module REST
Résumé
| Nom : | Obtenir l'artefact |
|---|---|
| Raison pour utiliser le service : | Pour récupérer l’étiquette d'expédition, l’étiquette Service de retour ou les documents requis pour le ramassage ou le dépôt de l'envoi (manifeste). Nota : Vous pouvez communiquer avec le service Obtenir l'artefact une deuxième fois si l'étiquette initiale est détruite. La même étiquette assortie du code à barres initial est produite après chaque demande de service. Des copies ne doivent pas être utilisées sur des colis différents. |
| Données d'entrée : | Il faut utiliser le lien associé à une demande de service précédente lorsque href contient « /ers/artifact » ou « /rs/artifact » et la valeur rel est assortie du type voulue. |
| Données de sortie : | Document PDF ou ZPL II |
| Exemples d'erreurs : | Lien invalide ou expiré |
| Demande de service précédente habituelle : | Créer l'envoi, Obtenir l'envoi, Obtenir le manifeste, ou Créer un retour autorisé |
| Prochaine demande de service habituelle : | Obtenir le tarif de l'envoi, Obtenir les détails du manifeste |
| Prochaine demande de service optionnelle : | Obtenir les détails de l'envoi ou Créer l'envoi (pour continuer à créer des envois) |
| Historique des versions : |
Obtenir l'artefact – Résumé du service
Détails sur la demande
Structure de la demande pour obtenir l'artefact
Point final
Il faut utiliser le lien associé à une demande de service précédente lorsque href contient « ers/artifact » ou « /rs/artifact » et que la valeur rel est assortie du type d'étiquette voulue (voir la section Points finaux fournis).
En-têtes HTTP
HTTP Header Variable |
Value |
|---|---|
Accept |
application/pdf ou application/zpl (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
Les données d'entrée XML ne sont pas nécessaires pour le service Obtenir l'artefact.
Détails de la réponse
Le service Obtenir l'artefact n'affiche pas les éléments de données XML. (Il affiche plutôt les commandes ZPL II ou les données binaires du fichier PDF.)
Réponse – Réponses d'erreur possibles
Aucune erreur n'est prévue pour l'utilisation de ce lien, mais vous apercevrez une erreur 404 si vous utilisez le service Obtenir l'artefact plus de 90 jours après que le lien a été fourni. Si vous utilisez le service Obtenir l'artefact pour récupérer une étiquette de retour autorisée, vous avez seulement cinq jours civils à récupérer cette étiquette.
Veuillez consulter la section Codes de statut HTTP pour obtenir de plus amples renseignements.
Exemples
Exemple de demande REST – Obtenir l'artefact
GET https://XX/ers/artifact/0456cd17e32a0039/3584/0
Accept:application/pdf
Authorization:Basic s7HD7gwsennesc==
Nota : Le lien vers le point final HTTP et la valeur « Accept » ne doivent pas être intégrés. Ces valeurs doivent plutôt être fournies à titre de données de sortie pour les services Créer l'envoi, Obtenir l'envoi, Obtenir le manifeste ou Créer un retour autorisé.
Exemple de réponse XML – Obtenir l'artefact
Le service Obtenir l'artefact n'affiche pas les éléments de données XML.
(Il affiche plutôt une réponse HTTP des commandes de programmation ZPL II ou une représentation binaire du fichier PDF.)
