create-open-return-template-request

complexe

requis

Élément de niveau supérieur pour la demande.

mailed-by

simple

requis

(1 à 10 caractères numériques)

Il s'agit du numéro de client à 10 chiffres du client « Expédié par ».

Si le numéro fourni compte moins de 10 chiffres, le système ajoutera des zéros au début.

mobo

simple

optionnel

(1 à 10 caractères numériques)

Il s'agit du numéro de client à 10 chiffres du client « Expédié au nom de ».

S'il manque cet élément, le numéro du client « Expédié par » s'affichera par défaut.

Si le numéro fourni compte moins de 10 chiffres, le système ajoutera des zéros au début.

locale

simple

optionnel

Indique votre langue de préférence pour recevoir les messages d'erreur.

EN = Anglais
FR = Français

Si aucune valeur n'est fournie, la langue par défaut est « Anglais ».

open-return

complexe

requis

Structure contenant les détails sur l'étiquette du Service de retour.

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 ».

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 characters)

Ligne d'adresse 1 du destinataire.

address-line-2

simple

optionnel

(44 characters)

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 données codées en base64. Décodez le fichier pour obtenir les 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, 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 par défaut est « Faux ».

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.

create-open-return-template-response

complexe

Il s'agit de l'élément XML de niveau supérieur de la structure de la réponse.

Il affichera les résultats d'une exécution réussie ou la structure d'un message d'erreur.

open-return

complexe

Cette structure contient les résultats liés à l'exécution réussie du service.

artifacts-remaining

simple

Il s'agit du nombre d'artefacts restants qui peuvent être utilisés. Il est habituellement défini en fonction du nombre d'étiquettes dans la demande.

template-id

simple

Numéro d'identification correspondant au modèle qui vient tout juste d'être créé.