Aperçu des retours | Portail des développeurs de Postes Canada

[title] | test

Utilisation

L’API de retour vous permet de créer des étiquettes d’expédition pour les retours autorisés et les retours ouverts. Dans les deux cas, les étiquettes de retour générées ne sont facturées que lorsqu’elles sont utilisées. Par ailleurs, elles ne sont associées à aucun manifeste et n’ont pas besoin d’être associées à une étiquette de commande.

Fonctionnement

Il existe deux types de retours :

Retours autorisés
L’adresse d’origine et de destination sont toutes les deux indiquées. Les caractéristiques du colis (poids, dimensions) sont connues et précisées.
Retours ouverts
Seule l’adresse de destination (destination finale du colis retourné) est indiquée. Les renseignements sur le colis sont inconnus et sont saisis lorsque le colis est déposé à Postes Canada.

Retours prévus

Pour les expéditrices et expéditeurs titulaires d’une convention, un troisième type de retour peut être mis en place, moyennant des frais, lors d’un appel de demande de service de création d’envois. Dans ce cas, l’interface API de création d’envoi fournira l’étiquette de départ et de retour dans le colis. Pour en savoir plus, consultez la section Créer l’envoi.

Dernières mises à jour de cette version

30 avril 2026

Nous avons mis à jour nos API afin d'améliorer la sécurité et les performances. Les protocoles sont désormais exclusivement REST avec une standardisation au format JSON (XML et SOAP ne sont plus pris en charge), et les jetons OAuth 2.0 Bearer sont maintenant obligatoires pour toutes les requêtes. Nous avons également ajouté des fichiers de configuration YAML et élargi le soutien pour 10 langages de programmation.

Pour en savoir plus, consultez les notes de mise à jour.

Retours autorisés
Retours ouverts
Flux de travail des retours autorisés

Le flux de travail des retours autorisés commence avec la récupération par l’API des renseignements d’expédition recueillis d’une application de la clientèle. L’API lance ensuite un appel pour créer un retour autorisé, puis un appel pour obtenir l’artéfact. Enfin, l’étiquette d’expédition de retour est imprimée.

Agrandir l’image
Appels concernant les retours autorisés
La fonction propre au service de retour est offerte au moyen des appels suivants :
Appels concernant les retours autorisés
Service Description
Créer une interface des retours autorisés Crée une étiquette de retour avec les renseignements sur l’adresse d’origine et de destination. Cette étiquette est envoyée par courriel à la personne qui retourne l’article par l’entremise d’un procédé libre-service ou de l’équipe du Service à la clientèle.
Obtenir un artéfact Récupère les données en format PDF ou ZPL II pour l’étiquette de retour autorisée.
Flux de travail des retours ouverts

Cet organigramme comporte deux volets principaux : le flux du procédé principal pour la création et l’utilisation de modèles de retours ouverts et les fonctions de récupération pour accéder aux modèles de retours ouverts existants ou les modifier. Le procédé principal comprend la création d’un modèle, la génération d’étiquettes pour plusieurs artéfacts et la suppression du modèle une fois terminé. Les fonctions de récupération permettent de récupérer, de modifier ou de supprimer des modèles existants avant de réintégrer le procédé principal.

Agrandir l’image
Appels concernant les retours ouverts
La fonction propre au service de retour est offerte au moyen des appels suivants :
Appels concernant les retours ouverts
Service Description
Modèle Créer un modèle générique pour les envois retournés
Crée des étiquettes génériques aux fins de récupération et d’impression. L’adresse de l’expéditeur et le poids du colis sont inconnus. Chaque étiquette comporte un code à barres unique, mais les autres données restent les mêmes. Les étiquettes peuvent être distribuées dans le cadre de l’envoi original ou envoyées à une personne en particulier.
Remarque :
Les étiquettes ne sont pas toutes générées au début. Au contraire, un sous-ensemble d’étiquettes sera créé et disponible pour la récupération dans la liste déroulante. À mesure que les étiquettes sont épuisées et presque à zéro, de nouvelles étiquettes peuvent être générées manuellement aux fins de réapprovisionnement.
Le nombre maximal d’étiquettes en attente est de 100 000.
Le nombre maximum de modèles est de 100.
Récupérer le prochain artefact générique pour les envois retournés récupérera le prochain artéfact disponible.
Récupérer le prochain artefact générique pour les envois retournés Récupère les données en format PDF ou ZPL II pour une étiquette de retour préétablie à l’aide du modèle Créer un modèle générique pour les envois retournés.
Obtenir le modèle générique pour les envois retournés
Récupère l’information qui permet d’accéder au service Récupérer le prochain artefact générique pour les envois retournés associé au modèle.
Remarque : Ce service renvoie une réponse identique à l’appel du modèle Créer un modèle générique pour les envois retournés qui a créé le modèle.
Obtenir les détails d’un modèle générique pour les envois retournés Récupère les renseignements originaux fournis lorsque l’on a appelé un modèle Créer un modèle générique pour les envois retournés. Cela comprend le nombre d’étiquettes précisées pour ce modèle, la ou le destinataire et plus encore. Cet appel fournit également le nombre d’étiquettes restantes pour ce modèle.
Supprimer le modèle générique pour les envois retournés Supprime un modèle générique pour les envois retournés existant.
Obtenir des modèles génériques pour les envois retournés Obtenir la liste des modèles de retour ouverts en fonction du numéro de client « Expédié au nom de ». Les modèles génériques pour les envois retournés actifs contiennent toujours des artefacts génériques pour les envois retournés disponibles aux fins de récupération. Une fois que tous les envois d’un modèle sont recueillis, le modèle générique pour les envois retournés est épuisé et supprimé.

Appels concernant les retours autorisés
Service	Description
Créer une interface des retours autorisés	Crée une étiquette de retour avec les renseignements sur l’adresse d’origine et de destination. Cette étiquette est envoyée par courriel à la personne qui retourne l’article par l’entremise d’un procédé libre-service ou de l’équipe du Service à la clientèle.
Obtenir un artéfact	Récupère les données en format PDF ou ZPL II pour l’étiquette de retour autorisée.

Appels concernant les retours ouverts
Service	Description
Modèle Créer un modèle générique pour les envois retournés	Crée des étiquettes génériques aux fins de récupération et d’impression. L’adresse de l’expéditeur et le poids du colis sont inconnus. Chaque étiquette comporte un code à barres unique, mais les autres données restent les mêmes. Les étiquettes peuvent être distribuées dans le cadre de l’envoi original ou envoyées à une personne en particulier. Remarque : Les étiquettes ne sont pas toutes générées au début. Au contraire, un sous-ensemble d’étiquettes sera créé et disponible pour la récupération dans la liste déroulante. À mesure que les étiquettes sont épuisées et presque à zéro, de nouvelles étiquettes peuvent être générées manuellement aux fins de réapprovisionnement. Le nombre maximal d’étiquettes en attente est de 100 000. Le nombre maximum de modèles est de 100. Récupérer le prochain artefact générique pour les envois retournés récupérera le prochain artéfact disponible.
Récupérer le prochain artefact générique pour les envois retournés	Récupère les données en format PDF ou ZPL II pour une étiquette de retour préétablie à l’aide du modèle Créer un modèle générique pour les envois retournés.
Obtenir le modèle générique pour les envois retournés	Récupère l’information qui permet d’accéder au service Récupérer le prochain artefact générique pour les envois retournés associé au modèle. Remarque : Ce service renvoie une réponse identique à l’appel du modèle Créer un modèle générique pour les envois retournés qui a créé le modèle.
Obtenir les détails d’un modèle générique pour les envois retournés	Récupère les renseignements originaux fournis lorsque l’on a appelé un modèle Créer un modèle générique pour les envois retournés. Cela comprend le nombre d’étiquettes précisées pour ce modèle, la ou le destinataire et plus encore. Cet appel fournit également le nombre d’étiquettes restantes pour ce modèle.
Supprimer le modèle générique pour les envois retournés	Supprime un modèle générique pour les envois retournés existant.
Obtenir des modèles génériques pour les envois retournés	Obtenir la liste des modèles de retour ouverts en fonction du numéro de client « Expédié au nom de ». Les modèles génériques pour les envois retournés actifs contiennent toujours des artefacts génériques pour les envois retournés disponibles aux fins de récupération. Une fois que tous les envois d’un modèle sont recueillis, le modèle générique pour les envois retournés est épuisé et supprimé.