Pour créer un certain nombre d'étiquettes d'expédition génériques du Service de retour (jusqu'à 100000) lorsque l'adresse de l'expéditeur et le poids de l'article sont inconnus

Données d'entrée sur l'expédition

Liens vers les modèles créés et lien vers le service pour récupérer les étiquettes du Service de retour

Erreurs liées à l'adresse ou aux caractéristiques du colis

XX (Conception)

ct.soa-gw.canadapost.ca

XX (Production)

soa-gw.canadapost.ca

{Client « Expédié par »}

Votre numéro de client

{Client « Expédié au nom de »}

Numéro du client « Expédié au nom de » (ou répétez votre numéro de client)

Accept

application/vnd.cpc.openreturn-v2+xml (Remarque : */* à la place de la valeur de l’en-tête affichera un message d’erreur)

Content-Type

application/vnd.cpc.openreturn-v2+xml (Remarque : */* à la place de la valeur de l’en-tête affichera un message d’erreur)

Authorization

Basic {Encodage en base64 du code d'usager : mot de passe}

Accept-language

en-CA or fr-CA

open-return

Complexe

Requis

Structure XML générale pour les données d'entrée de la demande.

max-number-of-artifacts

Simple

Requis

Indique le nombre maximal d'artefacts (étiquettes du Service de retour) que vous pouvez générer et récupérer à l'aide de ce modèle. Il doit s'agir d'une valeur numérique se situant entre « 1 » et « 100 000 ».

service-code

Simple

Requis

(32 caractères alphanumériques)

Le Service de retour convient seulement pour les envois retournés du régime intérieur.

receiver

Complexe

Requis

Cette structure contient des données sur la destination correspondant à l'adresse du destinataire figurant sur l'étiquette. Les champs vides seront retirés pendant le formatage des adresses.

name

Simple

Requis

(44 caractères)

company

Simple

Optionnel

(44 caractères)

domestic-address

Complexe

Requis

Cette structure contient les données d'adressage du destinataire.
Les champs vides seront retirés pendant le formatage des adresses.

address-line-1

Simple

Requis

(44 caractères)
Ligne d'adresse 1 du destinataire.

address-line-2

Simple

Optionnel

(44 caractères)
Ligne d'adresse 2 du destinataire.

city

Simple

Requis

(40 caractères)
Ville du destinataire.

province

Simple

Requis

(2 caractères)
Province du destinataire.

postal-code

Simple

Requis

(Modèle du code postal canadien à six caractères : A9A9A9)

print-preferences

Complexe

Optionnel

Cette structure contient les préférences d'impression pour les étiquettes.

output-format

Simple

Optionnel

(7 caractères alphanumériques)
Les valeurs valides sont les suivantes :
- 8.5x11
- 4x6
Si cet élément n'est pas précisé, la valeur « 8.5x11 » s'affiche par défaut.

Remarque : Le format 3 po sur 5 po a été éliminé en juin 2016, mais pendant une période provisoire, il sera accepté et converti en format 4 po sur 6 po.

encoding

Simple

Optionnel

{PDF, ZPL}
Servez-vous de ce champ pour préciser le format de sortie pour votre étiquette du Service de retour : PDF ou ZPL II. Si le champ est vide, le format PDF sera sélectionné par défaut.

Si vous choisissez le format ZPL, la réponse du service « Obtenir l'artefact » inclura un fichier contenant des commandes d'impression ZPL II. Vous devrez ensuite coder une solution ou utiliser une application afin d'envoyer les commandes directement à une imprimante thermique.

Pour les étiquettes de format ZPL II, votre imprimante doit permettre la troncature. Utilisez notre exemple de code pour tester la capacité de votre imprimante à tronquer du texte.

Le format ZPL est uniquement disponible sur du papier thermosensible. L'élément <output-format> doit alors être de 4 po sur 6 po.

show-packing-instructions

Simple

Optionnel

{Vrai ou faux}
Cet élément indique si les directives d'emballage doivent être inscrites sur l'étiquette.
Si cet élément n'est pas précisé, la valeur « Faux » s'affiche par défaut.

customer-input-type

Simple

Optionnel

(20 caractères alphanumériques)

Utiliser ces éléments pour créer des étiquettes de retour qui contiennent un espace dans lequel vos clients peuvent entrer des données, comme un numéro de pièce, un numéro d’UGS, etc.

Ce champ ne s’applique qu’aux étiquettes de 4 x 6 et de 8,5 x 11.

Les valeurs valides sont les suivantes :

settlement-info

Complexe

Requis

Cette structure contient le numéro de convention de colis de départ standard aux fins de vérification.

contract-id

Simple

Requis

(10 caractères numériques)
Requis pour utiliser le service de retour générique. Seuls les clients commerciaux de Postes Canada titulaires d'une convention établie en fonction du volume peuvent utiliser le service.

open-return

Complexe

Il s'agit de l'élément XML de niveau supérieur pour la réponse.
Cette structure contient des renseignements sur la création d'un modèle générique pour les envois retournés.

artifacts-remaining

Simple

Il s'agit d'une valeur numérique désignant le nombre d'artefacts restants qui peuvent être utilisés. Elle est habituellement définie en fonction du nombre d'étiquettes dans la demande.

links

Complexe

générique pour les envois retournés qui vient d'être créé.

link

Complexe

La structure des liens comprend trois éléments de liens, c'est-à-dire un pour « rel=”self” », un pour « rel=”details” » et un pour « rel=”nextArtifact” ».

<link
href="https://XX/rs/12435/454545/openreturn/676767
rel="self"
media-type="application/vnd.cpc.openreturn-v2+xml" />

<link
href="https://XX/rs/12435/454545/openreturn/6767/details
rel="details"
media-type="application/vnd.cpc.openreturn-v2+xml" />

<link
href="https://XX/rs/12435/454545/openreturn/6767676
rel="nextArtifact"
media-type="application/vnd.cpc.openreturn-v2+xml" />

Chaque lien compte les trois attributs suivants :

1. href. String. Il s'agit du point final pouvant être utilisé pour présenter une demande de service à l'aide du code HTTP GET, POST ou DELETE aux fins d'exécution des services suivants : – Obtenir le modèle générique pour les envois retournés
   – Obtenir les détails sur le modèle générique pour les envois retournés
   – Récupérer le prochain artefact générique pour les envois retournés
   – Supprimer le modèle générique pour les envois retournés.

2. rel. String. Cela désigne l'objectif du lien. Dans ce cas, il y a trois valeurs possibles pour « rel= », notamment :

   rel="self"
   Cela signifie que le lien « href » est un pointeur lié au modèle générique pour les envois retournés qui vient d'être créé (p. ex. il peut être utilisé pour présenter une demande de service [en utilisant le code HTTP GET]) :
   – Service « Obtenir le modèle générique pour les envois retournés »
   – Service « Supprimer le modèle générique pour les envois retournés » pour le modèle créé

   rel="details"
   Cela signifie que le lien « href » est un pointeur pouvant être utilisé pour présenter une demande de service « Obtenir les détails sur le modèle générique pour les envois retournés » (en utilisant le code HTTP GET) pour le modèle créé.

   rel="nextArtifact"
   Cela signifie que le lien « href » est un pointeur permettant au client d'obtenir le prochain artefact (p. ex. étiquette) disponible aux fins de récupération. Par exemple, le lien « href » peut être utilisé (à l'aide du code HTTP POST) pour présenter une demande de service « Obtenir le prochain artefact générique pour les envois retournés » pour le modèle qui vient tout juste d'être créé.

3. media-type. L'attribut lié au type de média désigne le format et la structure de toutes les données d'entrée supplémentaires qui sont nécessaires pour présenter une demande de service en ligne désigné « href ». Il s'agit habituellement d'une chaîne désignant la version pertinente des services en ligne de Postes Canada pour les envois retournés.