Résumé des services

Utiliser les services d'expédition et de manifestes pour créer, gérer et traiter des envois et des manifestes, y compris effectuer l'étiquetage et le dépôt des colis aux fins de livraison.

Êtes-vous un nouveau client de Postes Canada? Lisez les renseignements généraux sur l'expédition, les manifestes et les envois expédiés au nom de clients.

La répartition du travail lié à l'expédition et aux manifestes ainsi que les services clés sont présentés ci-dessous.

Service d'expédition

La fonction du service d'expédition est fournie par l'entremise des appels suivants :

1. Créer l'envoi
   REST   |    SOAP Sert à créer un nouvel envoi, à demander la création d'une image électronique d'étiquettes d'expédition, et à fournir des liens vers ces étiquettes d'expédition et d'autres renseignements associés à l'envoi à expédier.
2. Obtenir l'envoi
   REST   |    SOAP Sert à récupérer les mêmes liens initialement fournis par l'appel de création d'envoi (utilisé pour la récupération).
3. Obtenir l'artefact
   REST   |    SOAP
   Sert à récupérer les étiquettes produites pour un envoi créé par un appel « Créer un envoi » antérieur. Il est possible d'y accéder plus d'une fois pour réimprimer une étiquette abîmée. Une fois que vous avez imprimé l'étiquette d'expédition, vous devez terminer le procédé d'expédition en créant un manifeste. Consultez le service de manifestes ci-après.
4. Obtenir le tarif
   de l'envoi
   REST   |    SOAP Sert à récupérer le tarif d'un envoi en format XML pour un envoi créé par un appel « Créer un envoi » antérieur.
5. Obtenir le reçu
   de l'envoi
   REST   |    SOAP Utilisé pour obtenir les renseignements relatifs au règlement en format XML pour un envoi pour lequel un manifeste n'est pas requis et qui a été payé par carte de crédit. Les données de la réponse peuvent être formatées pour imprimer un reçu de carte de crédit.
6. Obtenir les détails
   de l'envoi
   REST   |    SOAP Sert à récupérer les détails d'un envoi en format XML pour un envoi créé par un appel « Créer un envoi » antérieur.
7. Obtenir des informations sur les clés publiques de l'expédition
   REST   |    SOAP Utilisé pour récupérer les détails sur la clé publique, y compris la date d’expiration, le code QR, l’URL publique (URL non authentifiée)
8. Obtenir les groupes
   REST   |    SOAP Sert à récupérer la liste de codes uniques d'identification de groupe associés à un client (ou à un client
   « expédié au nom de ») pour lequel il y a des envois créés qui n'ont pas encore été transmis.
9. Obtenir les envois
   REST   |    SOAP Sert à récupérer les liens vers tous les envois associés à un groupe ou manifeste précis.
10. Annuler l'envoi
    REST   |    SOAP Sert à indiquer à Postes Canada qu'une étiquette imprimée a été abîmée ou annulée et qu'elle ne sera pas utilisée, et qu'il ne faut donc pas transmettre l'envoi ni le facturer.
11. Demander le remboursement d'un envoi
    REST   |    SOAP Sert à demander le remboursement d'un envoi déjà transmis pour lequel une étiquette a été imprimée sans qu'elle soit utilisée, car elle est abîmée.

Service de manifestes

Une fois que vous avez créé votre envoi et imprimé votre étiquette d'expédition, vous devez effectuer les étapes suivantes pour terminer le procédé d'expédition et produire un manifeste.

Important : Si vous ne créez pas de manifeste, nous allons vous facturer tous les envois non payés ainsi qu’un supplément par article. En apprendre davantage sur les envois non payés.

1. Effectuer une demande de service « Transmettre les envois » – Cela achemine les données d'expédition aux fins de facturation et de suivi à Postes Canada et fournit des renseignements dont vous avez besoin pour obtenir la demande « Obtenir le manifeste » pour créer votre manifeste (votre preuve de paiement sur papier requise pour tous les envois aux fins de dépôt ou de ramassage à Postes Canada). Vous devez produire ce manifeste pour tous les dépôts ou les ramassages d'envois.
2. Effectuer une demande de service « Obtenir le manifeste » – Les renseignements dans la réponse du service « Obtenir le
   manifeste » vous permettront d'effectuer la demande de service « Obtenir l'artefact » pour récupérer votre manifeste. Une demande de service « Obtenir le manifeste » réussie est votre confirmation qu'un manifeste a été créé avec succès.

Nota : Selon le nombre d'envois dans votre demande de service « Transmettre les envois », il pourrait y avoir un retard avant que nous puissions fournir avec succès une réponse à la demande de service « Obtenir le manifeste ». Si vous recevez l'erreur 9153 dans la réponse à la demande de service « Obtenir le manifeste », veuillez attendre puis continuer de faire une demande de service « Obtenir le manifeste » jusqu'à ce que vous receviez une réponse positive. Permettez des pauses, au besoin.

3. Effectuer une demande de service « Obtenir l'artefact » – Les renseignements dans la réponse de la demande de service
   « Obtenir l'artefact » vous permettent de récupérer et imprimer votre manifeste que vous fournissez avec vos envois au moment du dépôt ou du ramassage.

Envoyer un exemple de demande REST – Transmettre les envois.

La fonction du service de manifestes est fournie par l'entremise des appels suivants :

Nota : Apprenez-en davantage sur les exigences et la procédure pour annuler un manifeste.

9. Transmettre
   les envois
   REST   |    SOAP Demande de service en ligne obligatoire qui doit être effectuée afin de déclencher le procédé de facturation. Après une demande de service « Transmettre les envois », vous devez effectuer avec succès une demande de service « Obtenir le manifeste » pour vous assurer que vos envois ont été transmis avec succès et qu'un manifeste est créé. Si vous ne créez pas de manifeste, nous allons vous facturer tous les envois non payés ainsi qu’un supplément par article. En apprendre davantage sur les envois non payés. Transmettre les envois sert à préciser les envois à être inclus dans un manifeste. L'inclusion dans un manifeste est précisée par groupe. Des envois précis peuvent être exclus, au besoin.
10. Obtenir le manifeste
    REST   |    SOAP Demande de service obligatoire qui doit être effectuée après une demande de service « Transmettre les envois ». Une demande de service « Obtenir le manifeste » réussie vous permet de confirmer qu'un manifeste a été créé avec succès. Vous pouvez également utiliser la demande de service « Obtenir le manifeste » pour récupérer des informations détaillées (détails, artefacts et envois) se rapportant à un manifeste donné. Si vous recevez l'erreur 9153 dans la réponse à la demande de service « Obtenir le manifeste », veuillez attendre puis continuer de faire une demande de service « Obtenir le manifeste » jusqu'à ce que vous receviez une réponse positive.
11. Obtenir l'artefact
    REST   |    SOAP Sert à récupérer les documents de manifeste créés. Vous devez fournir une copie papier du manifeste pour tous les envois que vous déposez ou qui ont été ramassés par Postes Canada. Cet appel peut être effectué plus d'une fois afin de réimprimer les documents.
12. Obtenir les détails
    du manifeste
    REST   |    SOAP Sert à récupérer les éléments XML affichant tous les détails liés aux coûts propres à un manifeste. Si le manifeste a été payé par carte de crédit, tous les éléments nécessaires pour imprimer une copie papier du reçu de carte de crédit sont fournis.
13. Obtenir
    les manifestes
    REST   |    SOAP Sert à récupérer une liste de manifestes (dans un intervalle de dates données) qui ont été transmis auparavant.

Service d'information sur les clients

Les services d’information sur les clients fournissent de l’information sur les rapports entre les numéros de client et les modes de paiement autorisés. Voici le diagramme habituel de ces services :

Terminologie

Un colis peut avoir jusqu’à trois numéros de client différents s’y rapportant, tel qu’illustré dans le tableau ci-dessous :

Type de numéro de client	Description
Expédié par	Le numéro de client de Postes Canada qui prépare/expédie le colis.
Expédié au nom de	Le numéro de client du propriétaire du courrier. Il s’agit habituellement du même numéro que le numéro de client « expédié par ». Par contre, le numéro sera différent si le client « expédié par » prépare/expédie des colis au nom d’un autre client.
Payeur	Le numéro de client de Postes Canada Post qui paie les frais d’expédition. Il s’agit habituellement du même numéro que celui du numéro de client « expédié par » ou « expédié au nom de ». Par contre, le numéro sera différent si quelqu’un d’autre paie les frais d’expédition.

Les services d’information sur les clients sont offerts par l’entremise de deux appels de service.

1. Obtenir l'information sur les clients
   REST   |    SOAP Retrouve des renseignements d’ordre général sur un client de Postes Canada, notamment le numéro de contrat, les payeurs valides, les modes de paiement autorisés pour chaque payeur et les liens vers les clients « expédiés au nom de » (le cas échéant), présents et passés.

   (Le client est identifié par le numéro « expédié par le client ».)

2. Obtenir l'information sur les clients
   « expédiés au
   nom de »
   REST   |    SOAP Récupère les renseignements généraux à propos du client « Expédié au nom de » de Postes Canada, notamment le numéro de la convention, les payeurs valides et les modes de paiement permis pour chaque payeur.

   (Le client « Expédié au nom de » est désigné par le numéro de client « Expédié au nom de ».)