Utilisation
Intégrez l’API de ramassage unique sur demande et préparez un ramassage de colis directement sur votre plateforme en ligne. Vous pouvez demander un ramassage unique sur demande unique à votre entreprise. Si votre contrat prévoit un ramassage par une tierce partie, vous pouvez également le demander à cet emplacement.
Fonctionnement
Suivez les étapes ci-dessous pour demander un ramassage :
- Déterminez si le ramassage est offert à votre emplacement et trouvez les heures limites.
- Utilisez le service Web de création d’une demande de ramassage. Entre autres éléments, votre demande comprendra les éléments suivants :
- Lieu de ramassage : Précisez si le ramassage est effectué à l’adresse commerciale qui figure au dossier ou à l’emplacement d’une tierce partie (veuillez noter que les ramassages par un tiers vous sont toujours facturés).
- Date de ramassage : Demandez un ramassage le jour où vous en avez besoin. Vous pouvez prévoir le ramassage jusqu’à 30 jours à l’avance si vous avez une convention de colis ou jusqu’à 5 jours à l’avance si vous n’en avez pas.
- Heure du ramassage : Choisissez une heure de disponibilité pour le ramassage entre midi et 16 h. Pour un ramassage le jour même, vous devez soumettre la demande au moins une heure avant l’heure souhaitée. Votre heure de fermeture doit être au moins une heure après l’heure choisie.
Consultez la liste complète des éléments au moyen du service Web de création d’une demande de ramassage.
Une fois la demande correctement soumise, vous recevrez le numéro de la demande et son état (en attente). Si vous demandez un ramassage le jour même après les heures limites de cette journée, le système affichera une erreur.
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.
Flux de travail du ramassage
Le flux de travail de ramassage commence par la vérification facultative de la disponibilité et de la tarification du service de ramassage de Postes Canada à un emplacement précis. Une fois la confirmation obtenue, une demande de ramassage peut être créée. Ensuite, le système peut récupérer toutes les demandes de ramassage, obtenir des renseignements sur une demande précise, modifier une demande existante ou annuler un ramassage à horaire fixe.
Appels de ramassage
La fonction propre au service de ramassage est offerte au moyen des appels suivants :
| Service | Description |
|---|---|
| Voir la disponibilité du service | Affiche la disponibilité du service de ramassage et les heures limites en fonction du lieu de ramassage (code postal saisi). |
| Obtenir le tarif de ramassage | Affiche le prix pour une demande de ramassage. |
| Créer un service de ramassage à la demande | Crée une demande de ramassage unique sur demande et affiche le numéro de demande et les liens (URL incluses dans la réponse API). |
| Obtenir les détails de la prise en charge | Utilise le numéro obtenu au moment de la création de la demande de ramassage et affiche un résumé des renseignements sur ce ramassage. |
Modifie les détails d’une demande de ramassage existante, comme les coordonnées ou l’heure de ramassage. Remarque : Si vous devez changer votre lieu de ramassage ou vos renseignements sur le paiement, annulez votre demande et créez-en une nouvelle. | |
| Annuler la commande à emporter | Annule une demande de ramassage existante. Remarque : Si vous annulez une demande à votre adresse commerciale par défaut, vous ne pourrez pas créer une nouvelle demande pour la même plage horaire. Mettez votre demande de ramassage à jour ou demandez une heure différente. |
| Annuler la commande à emporter | Affiche toutes les demandes de ramassage ouvertes et l’état de chacune. |
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.