Expédition avec convention
Obtenir l'envoi – Module REST
Résumé
| Nom : | Obtenir l'envoi |
|---|---|
| Raison pour utiliser le service : | Pour récupérer les liens et le NIP de repérage associés à un envoi créé précédemment |
| Données d'entrée : | Il faut utiliser le lien associé à une demande de service précédente. |
| Données de sortie : | Il s'agit du NIP de repérage de l'envoi et des liens vers les artefacts de l'envoi (étiquettes). L'état de l'envoi est également fourni. Nota : Les données de sortie du service Obtenir l'envoi sont identiques à celles service Créer l'envoi. |
| Exemples d'erreurs : | 404 – Introuvable |
| Demande de service précédente habituelle : | Créer l'envoi ou Obtenir les envois |
| Prochaine demande de service habituelle : | Obtenir l'artefact, Obtenir le tarif de l'envoi ou Obtenir les détails de l'envoi |
| Historique des versions : |
Obtenir l'envoi – Résumé du service
Détails sur la demande
Structure de la demande pour obtenir l'envoi
Point final
Il faut utiliser le lien associé à une de ces demandes de service précédentes.
Créer l'envoi lorsque rel="self"
Obtenir les envois lorsque rel="shipment"
(Consultez la section Points finaux fournis)
En-têtes HTTP
Variable des en-têtes HTTP |
Valeur |
|---|---|
Accept |
À partir du media-type dans le lien original (Remarque : */* à la place de la valeur de l’en-tête affichera un message d’erreur) |
Authorization |
Basic {Encodage en 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'envoi.
Détails de la réponse
Réponse – Éléments
La réponse du service Obtenir l'envoi est identique à celle du service Créer l'envoi et devrait aussi contenir :
- Le lien « rel=”refund” » si l’envoi a été transmis et que le remboursement n’a pas encore été demandé.
- Le lien « rel=”price” » si l’élément « provide-pricing-info » a été réglé à « true » dans la demande de création d’un envoi.
- Le lien « rel=”receipt” » si l’élément « provide-receipt-info » a été réglé à « true » dans la demande de création d’un envoi.
Consultez la section Réponse – Détails de l'élément de données pour obtenir les détails de la réponse.
Réponse – Diagramme XML
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'envoi plus de 90 jours après que le lien a été fourni.
Veuillez consulter la section Codes de statut HTTP pour obtenir de plus amples renseignements.
Exemples
Exemple de demande REST – Obtenir l'envoi
GET https://XX/rs/12341234/123456789/shipment/123456789012345678
Accept:application/vnd.cpc.shipment-v8+xml
Authorization:Basic s7HD7gwsennesc==
Exemple de réponse XML – Obtenir l'envoi
<shipment-info>
<shipment-id>347881315405043891</shipment-id>
<shipment-status>created</shipment-status>
<tracking-pin>123456789012</tracking-pin>
<po-number>P123456789</po-number>
<links>
<link rel="self" href="https://XX/rs/111111111/2222222222/shipment/347881315405043891" media-type="application/vnd.cpc.shipment-v8+xml"></link>
<link rel="details" href="https://XX/rs/111111111/2222222222/shipment/347881315405043891/details" media-type="application/vnd.cpc.shipment-v8+xml"></link>
<link rel="price" href="https://XX/rs/111111111/2222222222/shipment/347881315405043891/price" media-type="application/vnd.cpc.shipment-v8+xml"></link>
<link rel="receipt" href="https://XX/rs/111111111/2222222222/shipment/347881315405043891/receipt" media-type="application/vnd.cpc.shipment-v8+xml"></link>
<link rel="label" href="https://XX/rs/artifact/11111111/5555555/0" media-type="application/pdf" index="0"></link>
</links>
</shipment-info>
