Imprimer

Expédition avec convention

Exemples de codes pour l'expédition avec convention : Java (.zip) | PHP (.zip) | C# (.zip)

Obtenir les envois – Module REST

Résumé

Nom : Obtenir les envois
Raison pour utiliser le service :
  • Pour récupérer les liens vers un groupe d'envois n'ayant pas encore été transmis (membres d'un groupe)
  • Pour récupérer le lien vers un envoi précis.
  • Pour récupérer les liens vers 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
Données d'entrée : Il faut utiliser le lien associé à une demande de service précédente.
Données de sortie :

Liste de liens vers les ressources propres aux envois individuels.
Exemple d'erreur : Lien invalide ou expiré
Demande de service précédente habituelle : Obtenir les groupes ou Obtenir le manifeste
Prochaine demande de service habituelle : Obtenir l'envoi (répéter pour chaque envoi considéré)

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
Historique des versions :

Notes de mise à jour
Obtenir les envois – Résumé du service

Obtenir les envois – Résumé du service

Détails sur la demande

Structure de la demande pour obtenir les envois

Point final

Il faut utiliser le lien associé à une demande de service précédente pour obtenir les groupes lorsque rel="group".

OU

Il faut utiliser le lien associé à une demande de service précédente pour obtenir le manifeste lorsque rel="manifestShipments".

(Veuillez consulter la section Points finaux fournis)

OU

GET https://XX/rs/{Client « Expédié par »}/{Client « Expédié au nom de »}/shipment?trackingPIN={NIP de repérage}

OU

GET https://XX/rs{Client « Expédié par »}/{Client « Expédié au nom de »}/shipment?requestId={customer-request-id}

OU

GET https://XX/rs/{mailed by customer}/{mobo}/shipment?noManifest=true&date=YYYYMMDD&limit={number}

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 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 les envois, mais la chaîne de requête définie le type de recherche :

  • Par numéro d'identification de groupe (envois pas encore transmis dans ce groupe).
  • Par manifeste (envois sur ce manifeste).
  • Par NIP de repérage. 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.
  • Par élément « customer-request-id » (envoi précis)
  • Il s'agit d'envois pour lesquels un manifeste n'est pas requis, ce qui exige que vous passiez le paramètre {noManifest=true} pour désigner ce type de requête, et si vous le désirez, quelques paramètres de filtrage :
    • Date dans un format aaaammjj (la date actuelle est indiquée par défaut si le paramètre n'est pas fourni).
    • Limit – le nombre maximal de liens à inclure dans la réponse, du plus récent au plus ancien. (p. ex. limit=1 affichera uniquement l'envoi le plus récent). Le nombre par défaut est « 100 » si le paramètre n'est pas fourni. Ce nombre est limité à
      99 999 si un nombre plus grand que cette valeur est fourni.

Détails de la réponse

Réponse – Éléments

La réponse Obtenir les envois peut comprendre plusieurs envois et peut comprendre un lien Obtenir l’envoi pour chaque envoi ou la même réponse pour chaque envoi.

Pour obtenir un aperçu détaillé de la hiérarchie de la réponse, consultez le diagramme ci-dessous.

Obtenir les envois – Aperçu détaillé des éléments de réponse
Nom de l'élément Type Description

shipments

Complexe

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

link

Simple

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

La structure de niveau supérieur propre aux envois contient de nombreux éléments de liens. Consultez la section Points finaux fournis pour obtenir une description des attributs des liens.

L'attribut href peut être utilisé comme point final propre au service Obtenir l'envoi pour l'envoi en question. Consultez la section Obtenir l'envoi pour obtenir des renseignements sur la façon de présenter une demande pour ce service.

L'attribut href peut également être utilisé pour supprimer l'envoi à l'aide du service Annuler l'envoi. Consultez la section Annuler l'envoi pour obtenir des renseignements sur la façon de présenter une demande pour ce service.

shipment-info

Complexe

Réservé pour l'usage interne.

Réponse – Diagramme XML

Le diagramme suivant présente une réponse de niveau supérieur. Veuillez noter que l'attribut « index » présenté dans le diagramme n'est pas utilisé pour les services Obtenir les envois d'un groupe et Obtenir les envois d'un manifeste.

Obtenir les envois d'un groupe / Obtenir les envois d'un manifeste – Structure de la réponse XML

Obtenir les envois d'un groupe / Obtenir les envois d'un manifeste – Structure de la réponse XML

Réponse – Réponses d'erreur possibles

Le code de retour HTTP 404 (introuvable) s'affiche si aucun envoi n'a été trouvé. Cela signifie ce qui suit :

  • Le groupe ou le manifeste n'existe plus. Cela peut se produire parce que les groupes qui se vident à la suite de la transmission sont supprimés après 24 heures. Les manifestes et leurs envois connexes sont supprimés après 90 jours.
  • Aucun envoi portant la mention « Aucun manifeste requis » n'a été trouvé pour les paramètres précisés.

Le code de retour HTTP 202 (Accepté) est retourné si un envoi a été trouvé pour le paramètre « customer-request-id » fourni, mais que le processus concernant cet envoi n’est pas encore terminé. Vous pouvez continuer les sondages jusqu’à ce que le processus soit terminé.

D'autres messages d'erreur possibles pour ce service sont les suivants :

Code Description

9183

Seul l'un des paramètres de recherche doit être donné.

9185

Les paramètres « Limit » et « Date » ne s'appliquent qu'aux requêtes « noManifest=true requests ».

Exemples

Exemple de demande REST – Obtenir les envois d'un groupe/Obtenir les envois d'un manifeste

GET https://XX/rs/23243/234243/shipment?groupId=2342423
Accept:application/vnd.cpc.shipment-v8+xml
Authorization:Basic s7HD7gwsennesc==

Exemple de réponse XML – Obtenir les envois d'un groupe/Obtenir les envois d'un manifeste

<shipments>
<link rel="shipment" href="https://XX/rs/1111111111/222222222/shipment/33333333333" media-type="application/vnd.cpc.shipment-v8+xml"></link>
<link rel="shipment" href="https://XX/rs/1111111111/222222222/shipment/44444444" media-type="application/vnd.cpc.shipment-v8+xml"></link>
</shipments>