Intégration des services Web de ramassage des colis dans une plate-forme de cybercommerce

L'une des offres de service dans le cadre du Programme pour développeurs de Postes Canada est le service Web de ramassage de colis. Vous pouvez intégrer ces services dans votre solution de cybercommerce, de façon à faciliter les demandes de ramassage sur demande. Les services Web de ramassage sont la solution idéale pour les applications d'expédition à partir du magasin. Nos API vous permettent d'offrir une version intégrée de la fonction de ramassage sur demande qui se trouve dans notre outil de ramassage.

Fonctionnement des services Web de ramassage

Vous pouvez demander un ramassage à l'emplacement de votre entreprise ou à un emplacement de tierce partie. Pour profiter du ramassage en tierce partie, vous devez être un client commercial dont le ramassage en tierce partie est stipulé dans le contrat.

Suivez les étapes ci-après pour demander un ramassage :
  1. Déterminez si le ramassage est offert à votre emplacement Utilisez notre outil en ligne ou intégrez le service Web à votre solution : REST | SOAP. Vous pouvez également utiliser ce dernier pour trouver les heures limites.
  2. Faire une demandeFaire une demande de ramassage à l'aide de notre service Web « Créer une demande de ramassage » : REST | SOAP. Parmi les autres éléments, votre demande comprendra les suivants :
    • Lieu de ramassage : Précisez si le ramassage doit être effectué à l'adresse de l'entreprise figurant dans nos dossiers ou à un autre emplacement ou un emplacement de tierce partie (vous recevrez quand même la facture pour les services de ramassage en tierce partie).
    • Date de ramassage : Demandez un ramassage le jour où vous en avez besoin ou jusqu'à 30 jours à l'avance si vous êtes détenteur d'une convention de colis ou jusqu'à cinq jours à l'avance si vous ne l'êtes pas.

    • Heure de ramassage sur demande : Veuillez prendre note des éléments suivants : L'heure désirée doit se situer entre midi et 16 h. Pour les ramassages le jour même, vous devez soumettre la demande au moins une heure avant l'heure de ramassage désirée. Votre heure de fermeture doit être fixée au moins une heure après l'heure de ramassage désirée. Consultez la liste complète des éléments de la demande dans le service Web « Créer une demande de ramassage » : REST | SOAP.

  3. Obtenir une réponse La réponse à une demande de ramassage réussie vous acheminera le numéro d'identification de la demande et un statut « en attente ». Si vous soumettez une demande de ramassage le jour même après les heures limites pour cette journée, vous recevrez un message d'erreur.

Considérations en matière d'expédition à partir du magasin

Pour les applications d'expédition à partir du magasin, nous vous recommandons de créer votre solution de sorte que tous les magasins soient dotés de leur propre numéro de client de Postes Canada. Ainsi, chaque magasin peut facilement soumettre une demande de ramassage à son propre emplacement. Songez à ajouter une fonction de demande de ramassage dans votre panneau d'administration pour permettre au personnel du magasin de soumettre une demande de ramassage rapidement et facilement.

Les illustrations suivantes donnent un exemple de l'interface du panneau d'administration. Comme vous pouvez le constater, la plupart des champs sont prédéfinis pour faciliter la tâche du personnel du magasin.

Interface du panneau d'administration affichant les Commandes d’expédition à partir du magasin.
Interface du panneau d'administration affichant une demande de ramassage.

Services Web de ramassage supplémentaires

Après avoir réussi à soumettre une demande un ramassage, les services Web de ramassage suivants vous sont offerts :

  • Obtenir les détails sur la demande de ramassage Utilisez le numéro d'identification de la demande à partir de la réponse du service « Créer une demande de ramassage » pour obtenir un résumé de tous les renseignements propres à un ramassage.
  • Mettre à jour la demande de ramassage Modifiez les détails d'une demande de ramassage existante, notamment les renseignements sur la personne-ressource ou l'heure de ramassage. Si vous devez changer votre lieu de ramassage ou vos données de paiement, annulez votre demande de ramassage et créez-en une nouvelle.
  • Annuler une demande de ramassage Annulez une demande de ramassage existante. Veuillez noter que, si vous annulez une demande à l'adresse commerciale par défaut, vous ne pourrez pas en créer une autre pour le même créneau de temps. Utilisez le service « Mettre à jour la demande de ramassage » ou demandez une différente heure.
  • Récupérer les demandes de ramassage Récupérez toutes vos demandes de ramassage ouvertes, ainsi que leurs statuts.

Fonctionnement du paiement

Si vous êtes un client commercial de Postes Canada et que vous êtes détenteur d'une convention du service de colis, les ramassages à l'emplacement de votre entreprise seront facturés à votre compte. Si vous soumettez une demande de ramassage à un emplacement de tierce partie, elle vous sera également facturée, mais à la carte de crédit par défaut enregistrée dans votre profil Postes Canada.

Si vous n'êtes pas détenteur d'une convention du service de colis, les droits de ramassage seront imputés à la carte de crédit par défaut enregistrée dans votre profil.

Conseils pour la mise à l'essai dans notre environnement de développement

Utilisez notre environnement (de développement) « Bac à sable » pour valider votre schéma. Veuillez cependant noter que toutes les réponses sont figées. Cela signifie que vous pouvez vérifier la validité du format de votre demande, mais que les données dans notre réponse sont figées (statiques). Elles seront toujours les mêmes, peu importe les données dans votre demande.

Valeurs de mise à l'essai

Pour les services Web de ramassage qui nécessitent le numéro d'identification de la demande, utilisez la valeur de mise à l'essai suivante : 0074698052

Pour tester une erreur d'arrière-plan du service « Créer une demande de ramassage », réglez l'élément code postal comme « A9A9A9 » dans la structure de l'emplacement de ramassage. L'erreur « 11000 » s'affichera. Aucun autre message d'erreur ne sera affiché dans l'environnement du développement; par exemple, l'existence ou la validité de votre numéro de contrat ne sera pas confirmée.

Encore besoin d'aide?