Expédition
8.0.0
Expédition 8.0.0
Créer et gérer des étiquettes d’expédition et des manifestes
Pour obtenir l’accès, créez un compte ou se connecter.
Utilisation
L’API d’expédition de Postes Canada permet à notre clientèle de s’assurer que ses commandes sont livrées avec exactitude et dans les délais impartis.
Grâce à l’API, la clientèle peut :
- Traiter des commandes
- Créer des envois
- Générer des étiquettes
- Imprimer les manifestes
- Annuler des envois
- Demander des remboursements
- Imprimer les reçus
Remarque : L’API d’expédition de Postes Canada s’adresse à toutes les entreprises. Les services d’expédition avec convention sont offerts aux entreprises clientes. Communiquez avec le personnel de Postes Canada au 1 800 260-7678 pour obtenir des renseignements sur l’établissement d’une convention d’expédition avec nous.
Vous découvrez Postes Canada?
Fonctionnement
L’API de Postes Canada comprend une API d’expédition qui peut être complétée par un service de manifestes lorsque la mention « Manifeste requis » figure sur les étiquettes.
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.
Déroulement des procédés liés aux expéditions et aux manifestes
Le flux de travail d’expédition com mence avec la récupération par l’API des renseignements d’expédition recueillis d’une application de la clientèle et des renseignements recueillis lors de l’appel pour obtenir les tarifs. L’API divise ensuite le procédé en deux grandes étapes : le service d’expédition et le service de manifeste. Le service d’expédition comprend la création d’un envoi (avec les appels facultatifs pour obtenir le prix de l’envoi, obtenir le reçu de l’envoi, obtenir les détails de l’envoi et obtenir les informations sur la clé publique de l'expédition) et l'obtention d’un artéfact (l’appel pour annuler un envoi après l'obtention d’un artéfact est facultatif). Le service de manifeste comprend la transmission de l’envoi (l’appel pour demander le remboursement de l’envoi à la suite de la transmission de l’envoi est facultatif), l’obtention du manifeste et l’obtention d’un artéfact.
Une fois intégrée à votre plateforme ou application, l’API d’expédition de Postes Canada permet de créer des envois et des étiquettes, mais aussi d’annuler un envoi et de demander un remboursement.
Appels d’expédition
La fonction propre au service d’expédition est offerte avec les appels ci-après :
| Service | Description |
|---|---|
| Créer un envoi | Créer un nouvel envoi, y compris l’image de l’étiquette d’expédition, les liens et les détails associés. |
| Obtenir l’envoi | Récupérer les liens créés lors d’un appel de création d’envoi précédent. |
| Obtenir le prix de l’envoi | Récupérer les détails de la tarification d’un envoi créé lors d’un précédent appel de création d’envoi. |
| Obtenir les détails de l’envoi | Récupérer les détails d’un envoi créé lors d’un précédent appel de création d’envoi. |
| Obtenir des informations sur les clés publiques de l'expédition | Utilisé pour récupérer les détails sur la clé publique, y compris la date d’expiration, le code QR et l’URL publique (URL non authentifiée). |
| Obtenir des groupes | Récupérer tous les ID de groupe associés à un client ou une cliente (ou à une personne au nom de laquelle nous assurons l’expédition) pour les envois qui ont été créés. |
| Obtenir des envois | Récupérer toutes les expéditions associées à un groupe ou à un manifeste précis. |
| Obtenir le reçu de l’envoi | Récupérer les renseignements sur le paiement d’un envoi unique qui a été payé par carte de crédit et qui ne nécessite pas de manifeste. Les données retournées peuvent être formatées pour obtenir un reçu de carte de crédit à imprimer. |
| Obtenir un artéfact | Récupérer les étiquettes produites lors d’un précédent appel de création d’envoi. Il peut être utilisé plus d’une fois pour réimprimer une étiquette gâtée. Important! Une fois que vous avez imprimé l’étiquette d’expédition, si celle-ci indique « Manifeste requis », vous devez produire un manifeste et fournir une copie papier à Postes Canada avec votre envoi (voir l’étape 2 : Service de manifeste). |
| Envoi annulé | Indique qu’une étiquette imprimée pour un envoi avec manifeste a été gâtée ou annulée par le client ou la cliente et qu’elle ne doit pas être transmise ni facturée. |
| Demander le remboursement d’un envoi | Envoyer une demande de remboursement pour un envoi transmis pour lequel une étiquette a été imprimée, mais qui a par la suite été gâtée. |
Si votre envoi contient plusieurs colis et que vos étiquettes d’expédition indiquent « Manifeste requis », vous devez suivre la deuxième étape du procédé et créer un manifeste d’expédition avec le service Web Obtenir le manifeste.
Qu’est-ce qu’un manifeste?
Un manifeste d’expédition décrit le contenu d’un envoi, y compris le type et la quantité d’articles, l’adresse de destination, la date d’expédition, la valeur, le poids et les dimensions des articles, ainsi que toute directive ou exigence de manutention spéciale.
Pourquoi en ai-je besoin?
Le manifeste sert à consigner et à suivre le contenu de l’envoi en cas de perte ou de dommage. Il est également utilisé pour assurer la conformité à certaines réglementations régionales ainsi que le respect des directives de manutention spéciale requises pour les matières dangereuses ou périssables.
Que dois-je en faire?
Vous devez fournir un manifeste d’expédition lorsque vous remettez votre envoi au personnel de Postes Canada ou lorsque ce dernier vient le ramasser. Le manifeste précise le contenu de votre envoi et le nombre de colis qui le composent, et il sert de preuve de paiement.
Pour en savoir plus, consultez notre document d’information sur le manifeste.
Rappel : Veuillez soumettre le manifeste électronique de tous les colis avant le ramassage ou le dépôt. Les manifestes électroniques sont facultatifs pour les envois du régime intérieur seulement. Le non-respect de l’exigence de manifeste entraînera une facturation automatique et un supplément par article.
Remarque sur les envois non payés
Postes Canada surveille tous les envois pour s’assurer qu’ils sont bien accompagnés d’un manifeste. Pour éviter les frais de traitement, veuillez vous assurer que tous les envois sont accompagnés d’un manifeste électronique avant le ramassage ou le dépôt.
Si les envois sont traités sans manifeste :
- Ces articles vous seront facturés chaque semaine.
- Un supplément sera appliqué à tout article sans manifeste.
- Ces articles seront transférés à un nouvel ID de groupe (portant l’étiquette suivante : SCP-AUTOBILL[Date/Heure])
Rappel : Une fois qu’un manifeste automatisé est créé, vos ID de groupe originaux ne peuvent plus être transmis. Si vous essayez de le faire, cela générera l’erreur suivante :
9118 – ID du groupe : La valeur {0} est introuvable pour la transmission. Veuillez la supprimer ou la corriger.
Comment récupérer votre manifeste
Un manifeste automatisé sera envoyé par courriel à l’adresse associée à votre compte. Les développeurs peuvent également récupérer ces dossiers en envoyant une demande pour obtenir un manifeste à l’aide de l’ID du manifeste fourni.
En apprendre davantage sur les envois non payés
Appels de manifestes
La fonction propre au service de manifestes est offerte avec les appels ci-après :
| Service | Description |
|---|---|
| Transmettre l’envois | Téléverser les données d’expédition dans les systèmes de facturation et de suivi et récupérer les renseignements requis pour utiliser les services Obtenir le manifeste et Obtenir l’artéfact. L’appel de transmission de l’envoi déclenche le procédé de facturation et précise les envois qui doivent être inclus dans le manifeste. Important! Postes Canada facture tous les manifestes soumis par l’entremise d’appels de transmission de l’envoi dans l’environnement de production. Par conséquent, assurez-vous que la mise à l’essai est effectuée dans l’environnement de développement. |
| Obtenir le manifeste | Confirmer qu’un manifeste a été créé et récupérer les détails du manifeste. Remarque : Si cette demande provoque une erreur 9153, faites une courte pause, puis reprenez l’appel Obtenir le manifeste jusqu’à obtenir une réponse positive. Si la demande provoque une erreur 9154, l’appel de transmission de l’envoi a échoué et il faut effectuer un nouvel appel de transmission de l’envoi. |
| Obtenir un artéfact | Récupérer le manifeste créé. Cela vous permet d’imprimer votre manifeste aux fins de ramassage ou de dépôt de votre envoi. Effectuez cette demande aussi souvent que nécessaire pour réimprimer un manifeste donné. Rappel : Fournissez une copie papier du manifeste avec chaque envoi qui sera déposé ou ramassé. |
| Obtenir les détails du manifeste | Récupérer tous les détails des coûts associés à un manifeste donné. |
| Obtenir les manifestes | Récupérer une liste de manifestes transmis précédemment dans une plage de dates donnée. |
Annuler un manifeste
Commencer à utiliser l’API
Commencer
Consultez notre guide du développeur pour obtenir des renseignements sur les jetons d’accès, l’authentification, les limites de tarif et plus.
Obtenir du soutien
Trouvez les réponses aux questions courantes dans notre FAQ. Si vous ne les trouvez pas, communiquez avec notre équipe.