Exemples de codes pour les envois retournés :  REST  |  SOAP

Envois retournés

Créez des étiquettes d'expédition pour les retours autorisés et ouverts.

number

Lisez les premières étapes pour apprendre comment vous inscrire, comment obtenir vos clés API, et bien plus encore.

number

Pour obtenir de l'information essentielle commune à tous nos services en ligne, lisez les principes de base des services de Postes Canada pour les deux différents modules :   REST  |  SOAP

Résumé du service

Le service en ligne pour les envois retournés vous permet de créer des étiquettes d'expédition pour les retours autorisés et les retours génériques. Ces deux types d'envois produisent des étiquettes du Service de retour qui sont facturées au moment du balayage. Ces étiquettes ne sont pas associées à un manifeste et n'ont pas besoin d'être associées à une étiquette pour courrier de départ.

  • Retours autorisés – L'adresse de l'expéditeur et celle du destinataire sont précisées. Les caractéristiques du colis sont connues et précisées.
  • Retours génériques – Seule l'adresse du destinataire (soit le destinataire final du colis retourné) est précisée. Les caractéristiques du colis (poids et dimensions) sont habituellement inconnues, et elles sont saisies lorsque le colis est déposé à Postes Canada.

Nota : Un troisième type de retour est désigné et payé au moment de la présentation d'une demande de service « Créer l'envoi » (s'applique seulement à l'expédition avec convention). Dans ce cas, le service « Créer l'envoi » produira et fournira l'étiquette du Service de retour. Pour obtenir de plus amples renseignements, consultez la section Créer l'envoi.

Répartition des tâches et services clés

La répartition des tâches du Service de retour et les services clés sont présentés ci-dessous.

Retours autorisés

Authorized Returns

La fonction de retour autorisé est offerte par l'entremise des demandes de service suivantes.

  1. Créer un retour autorisé
    REST   |    SOAP
    Ce service est utilisé pour créer une étiquette du Service de retour lorsque l'adresse de l'expéditeur et le poids approximatif du colis sont connus. Une étiquette de ce genre est habituellement envoyée par courriel par l'entremise d'une option de libre-service ou d'un agent du service à la clientèle à la personne retournant l'envoi.
  2. Obtenir l'artefact
    REST   |    SOAP
    Ce service est utilisé pour récupérer le document PDF ou ZPL II pour l'étiquette du Service de retour autorisé.

Retours génériques

Open Returns

Nota : Dans les descriptions ci-dessous, l'« expéditeur » est le destinataire initial qui retourne le colis à l'expéditeur d'origine.

La fonction propre aux retours génériques est offerte par l'entremise des demandes de service suivantes.

  1. Créer un modèle générique pour les envois retournés
    REST   |    SOAP
    Ce service est utilisé pour les demandes de création d'é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 est dotée d'un code à barres unique, mais les autres données sont les mêmes. Les étiquettes peuvent être distribuées dans le cadre de l'envoi original ou envoyées à une personne en particulier.

    Remarques :

    • Les étiquettes ne peuvent pas toutes être générées dès le début. Un sous-ensemble sera plutôt généré et offert pour récupérer l'information. Lorsque le nombre d'étiquettes approche zéro, de nouvelles étiquettes seront générées aux fins de réapprovisionnement.
    • Le nombre maximal d'étiquettes que vous pouvez avoir en attente est de « 100 000 ».
    • Le nombre maximal de modèles est de « 100 ».
    • Il faut présenter une demande de service « Obtenir le prochain artefact générique pour les envois retournés » pour récupérer le prochain artefact disponible.
  2. Récupérer le prochain artefact générique pour les envois retournés
    REST   |    SOAP
    Ce service est utilisé pour récupérer le document PDF ou ZPL II pour un artefact (étiquette du Service de retour) préétabli à l'aide du service « Créer un modèle générique pour les envois retournés ».
  3. Obtenir le modèle générique pour les envois retournés
    REST   |    SOAP
    Ce service est utilisé pour récupérer les renseignements permettant l'accès au service « Récupérer le prochain artefact générique pour les envois retournés » associé au modèle.
    Nota : Ce service fournit une réponse identique à celle du service « Créer un modèle générique pour les envois retournés » ayant créé le modèle.
  4. Obtenir les détails sur le modèle générique pour les envois retournés
    REST   |    SOAP
    Ce service est utilisé pour récupérer les renseignements fournis à l'origine lors de la présentation d'une demande de service « Créer un modèle générique pour les envois retournés » pour créer le modèle (p. ex. le nombre d'étiquettes précisé pour ce modèle, le destinataire). Ce service fournit également le nombre d'étiquettes restantes pour ce modèle.
  5. Supprimer le modèle générique pour les envois retournés
    REST   |    SOAP
    Ce service est utilisé pour supprimer un modèle générique existant pour les envois retournés.
  6. Obtenir les modèles génériques pour les envois retournés
    REST   |    SOAP
    Ce service est utilisé pour récupérer la liste de modèles génériques actifs pour les envois retournés (selon le numéro du client « Expédié au nom de »). Les modèles génériques actifs pour les envois retournés sont ceux dont les artefacts sont toujours disponibles aux fins de récupération. Une fois que tous les artefacts d'un modèle ont été récupérés, le modèle générique pour les envois retournés est considéré comme épuisé, puis il est supprimé.