Notes de mise à jour des services Web de Postes Canada

Avec le temps, les services Web de Postes Canada vont changer et évoluer : de nouveaux services et de nouvelles options seront ajoutés, certains produits seront retirés, et des bogues seront résolus. Afin d'apporter ces modifications, nous devons changer le numéro de version du service Web. Le passage à la nouvelle version sera facultatif dans certains cas, mais obligatoire dans d'autres cas. Un préavis concernant les nouvelles caractéristiques et les nouvelles versions sera envoyé par courriel. Les anciennes versions seront prises en charge aussi longtemps que possible et un préavis sera fourni bien à l'avance si une version doit être retirée.

Catégories de services Web

Nos services Web sont regroupés en plusieurs catégories (p. ex. tarification, repérage, expédition avec convention). La version d'un service en ligne est désignée par un nom de version unique pour tous les services dans cette catégorie. On a attribué à chaque catégorie de services un nom de version initial pour commencer, et chacune peut faire l'objet d'un contrôle des versions indépendamment des autres catégories Vos applications doivent utiliser la même version que les services en ligne de Postes Canada lorsqu'elles font appel à une demande de service dans la même catégorie.

Contrôle des versions – REST

Les renseignements relatifs à la version sont transmis aux services Web de façon dynamique par l'entremise des variables des en-têtes HTTP Content-Type ou Accept (consulter Variables des en-têtes HTTP). L'information sur la version est ensuite retournée à partir des services Web de façon dynamique dans l'attribut media-type des éléments du lien.

Par exemple, voici les valeurs de l'en-tête pour le service Web de tarification :

Variable d'en-tête HTTP Valeur
Accept application/vnd.cpc.ship.rate-v4+xml
Content-Type application/vnd.cpc.ship.rate-v4+xml

Important : Si, dans le passé, pour vos demandes REST auprès de nos services Web , vous avez utilisé */* au lieu de l'en tête Accept, veuillez noter qu'à compter du 21 septembre 2013, nous ne prendrons plus en charge ces demandes. Vous devez indiquer une valeur pour l'acceptation et le type de contenu de votre en-tête HTTP.

Contrôle des versions – SOAP

Le numéro de version relatif aux appels SOAP auprès des services Web est précisé dans les variables du point final et de l'espace de nommage. Les fichiers WSDL renfermeront toujours les versions les plus récentes des services Web.

Statut, historique et notes de mise à jour de la version

Catégories de services Web Version Date de lancement Statut Notes de mise à jour Modifications du schéma Date de la mise hors service prévue
Tarification 4 13 avril 2019 Version
actuelle

Nouvel élément ajouté aux demandes de service Obtenir les tarifs soumises pour obtenir des dates de livraison plus précises pour des envois expédiés aux pays membres du Kahala Post Group (KPG).

Afficher les détails
3 13 juin 2016 Prise en charge

Ajout d’un code de rajustement dans la réponse au service Obtenir les tarifs permettant de rajuster les tarifs à la hausse ou à la baisse pour des combinaisons précises de codes postaux d’origine et de destination.

Afficher les détails
3 22 septembre 2014 Prise en charge

Ajout de nouveaux éléments à Découvrir les services afin de permettre une recherche des services postaux offerts pour un client, une convention ou un code postal d'origine ou de destination donnés.

Ajout du code de service DOM.DT à Obtenir les tarifs du service Livré ce soir
Afficher les détails
3 7 avril 2014 Prise en charge Nouvel élément dans la demande Obtenir les tarifs, permettant de saisir un code de réduction promotionnelle (uniquement pour une expédition sans convention). Si un code est fourni, la réponse comprend le montant de la réduction. Afficher les détails
2 5 janv. 2013 Prise en charge Nouvel élément « comment » dans la réponse du service Obtenir le service indiquant le montant maximal de couverture inclus pour quelques services vers les É.-U. et du régime international. Afficher les détails
1 21 nov. 2011 Prise en charge Version initiale
Expédition avec convention 8 13 juin 2016 Version actuelle

Modification du lien rel="label" retourné dans les réponses selon le module REST au moment de créer l’envoi et d’obtenir l’envoi.

Afficher les détails
8 Le 18 avril 2016 Version actuelle

Pour les envois à destination des États-Unis et du régime international, mises à jour apportées à Créer l’envoi :

  • Pour se conformer aux nouveaux règlements douaniers internationaux.
  • Pour permettre la prise en charge de certains caractères spéciaux par les champs du nom et du nom de l’entreprise.
  • Pour permettre de sélectionner la couverture maximale.

Un formatage supplémentaire sera maintenant pris en charge par les champs de numéro de téléphone.

Afficher les détails
8 11 jan. 2016 Version actuelle

Modifications apportées au service Créer l’envoi et à d’autres services Web d’expédition avec convention de façon à :

  • permettre aux fournisseurs de compte de fournisseur approuvés d’effectuer un paiement au moyen du compte de fournisseur pour leurs clients ou de préautoriser un paiement en leur nom;
  • vous permettre de demander que le prix et le reçu de l’envoi soient inclus dans la réponse du service Créer l’envoi;
  • vous permettre de définir votre numéro d’identification unique pour chaque envoi et de chercher des envois à l’aide de ce numéro.
Afficher les détails
7 30 mars 2015 Prise en charge

Demande de remboursement d'un envoi – Nouveau service Web pour demander le remboursement d'un envoi transmis par erreur.

Mises à jour apportées aux services d'expédition avec convention en vue du nouveau service Web.

Afficher les détails
7 25 octobre 2014 Prise en charge

Introduction du procédé simplifié de paiement
CR :

  1. Envoyer tous les envois CR à un bureau de poste en sélectionnant l'option Annoncer par carte ou l'option Livrer au bureau de poste.
  2. Les destinataires doivent ramasser leurs articles et payer le montant CR au bureau de poste.
  3. Les clients commerciaux doivent recevoir leurs paiements CR par voie électronique.

Retirés : étiquettes de paiement, étiquettes liées au registre de livraison et mode de paiement pour les envois CR.

Afficher les détails
6 23 juin 2014 Prise en charge

Nouvel élément de codage pour le service Créer l'envoi qui vous permet de préciser le format de sortie de vos étiquettes d'expédition : PDF ou ZPL II.

Si vous utilisez l'élément « transmit-shipment » afin d'indiquer un envoi pour lequel aucun manifeste n'est requis, vous serez désormais en mesure d'imprimer des étiquettes thermosensibles.

Nouveau champ qui vous permet d'indiquer qu'un envoi est un acheminement continu de marchandises d'arrivée (ACMA). Ce type d'envoi provient de l'extérieur du Canada et est admissible à une exemption de la TPS et de la TVH.

Afficher les détails
6 7 avril 2014 Prise en charge

Nouvelle option Expédition rapide pour les expéditeurs titulaires d'une convention, permettant de créer une étiquette contenant uniquement le code à barres de repérage.

Si l'expédition se fait à l'extérieur du Canada, le nom du destinataire ou de l'entreprise est nécessaire.

L'UGS a une nouvelle limite de caractères.

La façon de préciser l'endroit du ramassage ou du dépôt est plus flexible.

Afficher les détails
5 13 janv. 2014 Prise en charge

Soutien pour la sélection d'un lieu de dépôt.

Nouveaux champs de données liées aux douanes.

Le signe plus (+) fait partie des caractères valides dans les adresses électroniques.

Afficher les détails
4 23 sept. 2013 Prise en charge Nouvel élément « transmit-shipment » dans le service Créer l'envoi pour les clients qui expédient moins de 50 colis par jour à partir de différents endroits. Afficher les détails
3 16 juin 2013 Prise en charge Soutien pour les adresses de manifestes à destination des États-Unis.
2 5 janv. 2013 Prise en charge Valeurs pour douanes mises à jour pour prendre en considération les montants d'argent plus élevés.
1 21 nov. 2011 Prise en charge Version initiale
Renseignements sur le client 1 21 nov. 2011 Version actuelle Version initiale
Expédition sans convention 4 13 juin 2016 Version actuelle

Modification du lien rel="label" retourné dans les réponses selon le module REST au moment de créer l’envoi et d’obtenir l’envoi.

Afficher les détails
4 Le 18 avril 2016 Version actuelle

Pour les envois à destination des États-Unis et du régime international, mises à jour apportées à Créer l’envoi sans convention :

  • Pour se conformer aux nouveaux règlements douaniers internationaux.
  • Pour permettre la prise en charge de certains caractères spéciaux par les champs du nom et du nom de l’entreprise.
  • Pour permettre de sélectionner la couverture maximale.

Un formatage supplémentaire sera maintenant pris en charge par les champs de numéro de téléphone.

Afficher les détails
4 le 30 mars 2015 Version actuelle

Demande de remboursement pour un envoi sans convention – Nouveau service Web pour demander le remboursement d'une étiquette ou d'un envoi créé par erreur.

Mises à jour apportées aux services d'expédition sans convention en vue du nouveau service Web.

Afficher les détails
4 Le 25 octobre 2014 Version actuelle

Introduction du procédé simplifié de paiement
CR :

  1. Envoyer tous les envois CR à un bureau de poste en sélectionnant l'option Annoncer par carte ou l'option Livrer au bureau de poste.
  2. Les destinataires doivent ramasser leurs articles et payer le montant CR au bureau de poste.
  3. Les clients commerciaux doivent recevoir leurs paiements CR par voie électronique.

Retirés : étiquettes de paiement, étiquettes liées au registre de livraison et mode de paiement pour les envois CR.

Afficher les détails
3 7 avril 2014 Prise en charge

<requested-shipping-point> passe de requis à optionnel.

Si l'expédition se fait à l'extérieur du Canada, le nom du destinataire ou de l'entreprise est nécessaire.

Nouvelle structure ajoutée pour permettre la saisie d'un code de réduction promotionnelle.

Afficher les détails
2 13 janv. 2014 Prise en charge

Nouveau champ pour le code postal du bureau de poste où les envois seront déposés.

Nouveaux champs de données liées aux douanes.

Le signe plus (+) fait partie des caractères valides dans les adresses électroniques.

Afficher les détails
1 21 avril 2012 Prise en charge Version initiale
Repérage 2 16 avril 2016 Version actuelle de REST V2 de REST créée afin de corriger l’espace de nommage pour les messages d’erreur
1 21 nov. 2011 Version actuelle de SOAP Version initiale
Trouver un bureau de poste 1 22 septembre 2014 Version actuelle Ajout de nouveaux éléments à Obtenir le bureau de poste le plus près afin que les utilisateurs puissent demander une liste des bureaux de poste acceptant les colis assortis de l'option « Livrer au bureau de poste » qui offrent le service Livré ce soir. Afficher les détails
1 21 nov. 2011 Version actuelle Version initiale
Service de ramassage 1 printemps 2015 Version actuelle Version initiale
Disponibilité du service de ramassage 1 21 nov. 2011 Version actuelle Version initiale
Envois retournés (retours autorisés) 2 12 février 2023 Version actuelle Dans le service Créer un retour autorisé, il est désormais possible de générer un code QR et d'ajouter un code-barres lisible supplémentaire, en ajoutant 3 champs à la demande et 2 champs à la réponse. Afficher les détails
2 8 février 2020 Version actuelle Dans le service Créer un retour autorisé, le soutien pour l’URL de l’étiquette publique a été ajouté. Afficher les détails
2 13 juin 2016 Version actuelle Les étiquettes de retour de 3 po sur 5 po ont été éliminées. Pour les étiquettes en format ZPL, utilisez des étiquettes de 4 po sur 6 po. Les étiquettes en format PDF de 3 po sur 5 po seront acceptées pendant une période provisoire, puis converties en étiquettes de format 4 po sur 6 po. Afficher les détails
Toutes les versions 23 juin 2014 Version actuelle Dans le service Créer un retour autorisé, l'élément « weight » est facultatif plutôt qu'obligatoire. Afficher les détails
2 23 juin 2014 Version actuelle Dans le service Créer un retour autorisé, le soutien pour l'impression des étiquettes du Service de retour sur du papier thermosensible de 4 po sur 6 po dans un format ZPL II a été ajouté. Afficher les détails
2 13 janv. 2014 Version actuelle

Le signe plus (+) fait partie des caractères valides dans les adresses électroniques.

Une fois que vous avez créé une étiquette du Service de retour autorisé, vous avez cinq jours civils – au lieu de deux jours – pour la récupérer (à l'aide du service
« Obtenir l'artefact »).

1 21 avril 2012 Prise en charge Version initiale
Envois retournés (retours génériques) 2 13 juin 2016 Version actuelle Les étiquettes de retour de 3 po sur 5 po ont été éliminées. Pour les étiquettes en format ZPL, utilisez des étiquettes de 4 po sur 6 po. Les étiquettes en format PDF de 3 po sur 5 po seront acceptées pendant une période provisoire, puis converties en étiquettes de format 4 po sur 6 po. Afficher les détails
2 23 juin 2014 Version actuelle Dans le service Créer un modèle générique pour les envois retournés, le soutien pour l'impression des étiquettes du Service de retour sur du papier thermosensible de 4 po sur 6 po dans un format ZPL II a été ajouté. Afficher les détails
2 5 janv. 2013 Version actuelle Nouveau champ pour la saisie de commentaires des clients sur l'étiquette d'expédition. Afficher les détails
1 21 avril 2012 Prise en charge Version initiale
Plates-formes de cybercommerce 2 11 jan. 2016 Version actuelle La réponse envoyée par le service Web « Obtenir l’information sur l’inscription du commerçant » comprend un indicateur qui précise si le commerçant a un compte de tiers figurant dans les dossiers de Postes Canada pouvant être utilisé pour les transactions d’expédition. Afficher les détails
1 16 juin 2012 Prise en charge Version initiale
Obtenir de l'information sur le service 2 7 avril 2014 Version actuelle S'il n'existe aucun message en attente, le code d'erreur HTTP 200 (OK) s'affiche avec une réponse vide, p. ex. <info-messages></info-messages>. Auparavant, le code d'erreur 404 (introuvable) s'affichait.
1 23 sept. 2013 Prise en charge Version initiale

Modifications du schéma

Service Web Version Élément touché Statut de l'élément Description du changement
Catégorie « Tarification »
Découvrir les services
(demande REST)
3 Paramètres de requête Nouveau

Élément facultatif

Ajout des paramètres de requête « contract », « origpc » et « despc » afin de permettre une recherche des services postaux offerts pour un client, une convention ou un code postal d'origine ou de destination donnés.
Découvrir les services (demande SOAP) 3 <customer-number> Nouveau

Optionnel

S'ils ont été fournis dans la demande, la réponse comprendra tous les services offerts au client sans convention.
3 <contract-id> Nouveau

Optionnel

Si l'élément « contrat-id » est fourni, la réponse comprendra également les services restreints accessibles grâce à cette convention.
3 <origin-postal-code> Nouveau

Optionnel

Code postal au format « A9A » ou « A9A9A9 ».

Si l'élément « origin-postal-code » est fourni, tout service qui n'est pas valide pour cette origine sera éliminé, ce qui ne s'applique qu'au service Livré ce soir. L'origine peut correspondre à votre code postal (si le courrier est ramassé par Postes Canada) ou au code postal de l'emplacement où vous déposez votre courrier.

Le service Livré ce soir pourrait être inclus dans la réponse lorsque seulement l'élément « contract-id » est fourni (p. ex., offert en vertu de la convention), mais une fois que les codes postaux d'origine et de destination sont fournis, le service Livré ce soir peut ne plus être applicable.

Les codes postaux d'origine et de destination doivent être fournis pour confirmer que le service Livré ce soir est disponible pour un envoi donné.

Pour déterminer si le service Livré ce soir est un service offert dans votre région, fournissez le code postal d'origine sans le code postal de destination.
3 <destination-postal-code> Nouveau

Optionnel

Code postal au format « A9A » ou « A9A9A9 ».

Si l'élément « origin-postal-code » est fourni, l'élément « origin-postal-code » doit également être fourni. Les deux éléments sont ensuite utilisés pour confirmer la disponibilité du service Livré ce soir. La destination peut correspondre au code postal du destinataire ou au code postal du bureau de poste où l'envoi est expédié (à l'aide de l'option Livré au bureau de poste).
Obtenir les tarifs (demande) 4 <postal-code> Nouveau

Optionnel

Le champ relatif au code postal peut être fourni si le client aimerait recevoir une garantie de date de livraison pour un pays membre du Kahala Post Group (KPG).

3 <promo-code> Nouveau

Optionnel

Si vous avez un code de réduction promotionnelle, saisissez-le ici. Le montant de la réduction sera affiché dans la réponse sous la structure <adjustment> et la valeur <adjustment-code> PROMODISC.

Obtenir les tarifs (réponse) 3 <adjustment-code> Modifié

Ajout d’un code pour :

SAADJ – Ajustement pour zone de service (rajustement tarifaire à la hausse ou à la baisse pour des combinaisons précises de codes postaux d’origine et de destination)

Obtenir le service (réponse) 2 <comment> Nouveau Message indiquant le montant maximal de couverture inclus avec ce service (qui peut être aucune); l'information est retournée uniquement pour quelques services vers les É.-U. et le régime international pour lesquels on ne peut pas acheter une couverture supplémentaire.
Catégorie « Expédition avec convention »
Créer l'envoi (demande) 8 <client-voice-number> Modifié

Mise à jour pour prendre en charge :

  • Un symbole d’addition (+), mais seulement tout au début de la chaîne de caractères.
  • Un point (.), un tiret (-), des parenthèses ou une espace suivie d’un « x » ou d’un « p » pour indiquer un numéro de poste.

8 <option-amount> Modifié

Ne pas fournir pour l’option COV dans le cas des envois à destination des États-Unis ou du régime international si vous voulez que le système calcule la couverture maximale permise (voir l’élément option-qualifier-1 ci-dessous).

8 <option-qualifier-1> Modifié

Mise à jour pour permettre l’utilisation avec l’option COV pour les envois à destination des États-Unis ou du régime international. Utiliser ce champ pour indiquer que le système peut appliquer le montant de la couverture maximale permise, qui devrait correspondre à la valeur totale de vos articles, jusqu’à la limite maximale permise pour le produit et le pays en question :

  • Vrai = Utiliser la couverture maximale permise; lorsqu’elle est utilisée, il n’est pas nécessaire de fournir option-amount.
  • Faux (par défaut) = Utiliser le montant de la couverture indiquée dans option-amount.

8 <currency> Modifié

Mise à jour pour valider que la devise est conforme à un code de devise ISO valide.

8 <reason-for-export> Modifié

GIF (cadeau) n’est plus une raison d’exportation valide, tel qu’il a été déterminé par l’Organisation mondiale des douanes pour les envois commerciaux.

8 <other-reason> Modifié

Mise à jour afin d’indiquer que ce champ doit contenir au moins quatre caractères (maximum de 40 caractères).

Créer l'envoi (demande) 8 <customer-request-id> Nouveau

Optionnel

Un numéro d’identification unique que vous pouvez définir pour cet envoi. Il doit être unique ou la demande sera rejetée. Les fournisseurs de compte de fournisseur doivent utiliser ce champ pour indiquer un numéro d’identification unique pour tout envoi associé à une demande de paiement préautorisé.

8 <provide-pricing-info> Nouveau

Optionnel
{true}
Cet élément indique que vous voulez que la structure tarifaire des envois soit incluse dans la réponse à cette demande. Cela entraîne une plus grande charge, mais élimine la nécessité de soumettre une autre demande Obtenir le tarif de l’envoi.
S’applique uniquement aux envois où l’élément « transmit-shipment » est réglé à « true ».
Fournir ce paramètre uniquement si vous voulez obtenir des détails sur la tarification dans la réponse (ne pas le fournir lorsque l’élément est réglé à « false »).

8 <provide-receipt-info> Nouveau

Optionnel
{true}
Cet élément indique que vous voulez que la structure « shipment-receipt » soit incluse dans la réponse à cette demande. Il en résulte une plus grande charge, mais cela élimine la nécessité de soumettre une autre demande Obtenir le reçu de l’envoi.
Ne s’applique qu’à un envoi où l’élément « transmit-shipment=true » est payé par carte de crédit ou par compte de fournisseur.
Fournir ce paramètre uniquement si vous voulez que les détails du reçu soient indiqués dans la réponse (c.-à-d. qu’il ne faut pas le fournir lorsque l’élément est réglé à « false »).

8 <intended-method-of-payment> Modifié

Ajout du compte de fournisseur comme mode de paiement. Cela indique que le paiement sera effectué au moyen du compte de fournisseur indiqué dans l’élément « pre-authorized-payment » ou désigné comme valeur par défaut dans le profil du client (offert uniquement aux fournisseurs de comptes de fournisseur).
Cet élément indique votre mode de paiement pour un envoi n’exigeant pas de manifeste (« transmit-shipments=true »), ou lorsque le mode de paiement voulu est différent (le mode de paiement réel est indiqué dans la demande de service « Transmettre les envois » subséquente).

8 <promo-code> Nouveau

Optionnel
Code de réduction promotionnelle. Veuillez noter que les codes promotionnels sont uniquement valides pour une certaine période et pour certains produits.
Remarque : Le code promotionnel DEVPROTEST peut être utilisé pour la mise à l’essai des fonctions dans l’environnement « bac à sable ». Ce code promotionnel est uniquement valide dans l’environnement « bac à sable » et pour les produits suivants :

  • Xpresspost (DOM.XP)
  • Xpresspost International (INT.XP)

8 <pre-authorized-payment> Nouveau

Optionnel
Les fournisseurs de comptes de fournisseur peuvent préautoriser les paiements à l’aide du compte de fournisseur de leurs clients.
Important : Cette fonction ne peut être utilisée que par les fournisseurs de comptes de fournisseur approuvés par Postes Canada, et ce, uniquement pour les envois n’exigeant pas de manifeste.

8 <account-number> Nouveau

Requis
Le numéro de compte à partir duquel le montant sera retiré; sera utilisé aux fins de rapprochement.

8 <auth-code> Nouveau

Requis
Le code d’autorisation du fournisseur; sera utilisé aux fins de rapprochement.

8 <auth-timestamp> Nouveau

Requis
La date et l’heure d’autorisation; seront utilisés aux fins de rapprochement.

8 <charge-amount> Nouveau

Requis
Le montant autorisé en dollars canadiens; doit correspondre au total des frais qui seront calculés.
Format 9999999,99 (les zéros indiqués au début ne sont pas requis).

Créer l'envoi (réponse) 8 lien rel="label" Modifié

Le lien rel="label" s’affiche maintenant dans le format suivant : (/ers a été remplacé par /rs) : href="https://XX/rs/artifact/11111111/5555555/0" media-type="application/pdf" index="0">

Créer l'envoi (réponse) 8 <customer-request-id> Nouveau

Votre code de transaction unique, si vous l’avez indiqué dans votre demande.

8 <shipment-price> Nouveau

Cette structure sera uniquement retournée pour les envois n’exigeant pas de manifeste et où l’élément « provide-pricing-info » est réglé à « true » dans la demande.
La structure contient les mêmes éléments fournis dans la réponse visant à obtenir le tarif de l’envoi.

8 <shipment-receipt> Nouveau

Cette structure sera uniquement retournée pour les envois n’exigeant pas de manifeste et qui ont été payés par carte de crédit ou par compte de fournisseur.
Elle contient les mêmes éléments fournis dans la réponse à l’élément Obtenir le reçu de l’envoi. Veuillez noter que les mêmes valeurs fictives sont toujours retournées dans l’environnement « bac à sable » (p. ex., code d’autorisation AA1111).

Obtenir l’envoi (réponse) 8 lien rel="label" Modifié

Le lien rel="label" s’affiche maintenant dans le format suivant : (/ers a été remplacé par /rs) : href="https://XX/rs/artifact/11111111/5555555/0" media-type="application/pdf" index="0">

Obtenir l’envoi (réponse) 8 <customer-request-id> Nouveau

Votre code de transaction unique, si vous l’avez indiqué dans votre demande.

Obtenir les détails de l'envoi (réponse) 8 <customer-request-id> Nouveau

Votre code de transaction unique, si vous l’avez indiqué dans votre demande.

8 <adjustment-code> Modifié

Ajout de trois codes de rajustement :

  • V1DISC – Économies du programme Solutions pour petites entreprises
  • PROMODISC – Réduction promotionnelle (si le code de promotion est invalide ou expiré, le montant de la réduction sera indiqué comme étant zéro sous adjustment-cost).
  • PLATFMDISC: Réduction pour utilisation d’une plateforme de cybercommerce
  • NEWREGDISC: Réduction accordée lors de l’inscription au Programme pour développeurs

Obtenir le reçu de l'envoi (réponse) 8 <shipment-cc-receipt> Modifié

L’élément XML « shipment-cc-receipt » a été renommé « shipment-receipt ».

8 <supplier-account-receipt-details> Nouveau

Cette structure sera fournie uniquement si l’envoi a été payé par compte de fournisseur.
Cette structure n’est pas retournée dans l’environnement « bac à sable ».

8 <merchant-name> Nouveau

La valeur sera la suivante : « Canada Post ».

8 <merchant-url> Nouveau

La valeur sera la suivante : « www.canadapost.ca ».

8 <auth-code> Nouveau

Le code d’autorisation reçu du fournisseur.

8 <auth-timestamp> Nouveau

La date et l’heure auxquelles le fournisseur a autorisé la transaction.

8 <supplier-id> Nouveau

Le fournisseur qui a autorisé la transaction. Les valeurs sont :

  • FP = FrancoTyp Postalia
  • NE = Neopost
  • PB = Pitney Bowes

8 <charge-amount> Nouveau

Le montant total facturé au compte.

8 <currency> Nouveau

La devise de la transaction; toujours CAD.

8 <transaction-type> Nouveau

La valeur sera la suivante : « Sale ».

Obtenir les envois (demande REST) 8 Query parameters Nouveau

Ajout de paramètres de requête. Faire une recherche par :

  • Numéro de demande du client

Obtenir les envois (demande SOAP) 8 <provide-shipment-info> Nouveau

Réservé pour l'usage interne.

8 <customer-request-id> Nouveau

Optionnel
Le numéro de demande du client associé à l’envoi pour lequel des renseignements sont demandés.
Ces éléments sont mutuellement exclusifs avec les paramètres « regular-shipping-parameters », « no-manifest-shipping-parameters » et « tracking-pin ».

Obtenir les envois (réponse) 8 <shipment-info> Nouveau

Réservé pour l'usage interne.

Transmettre les envois (demande) 8 <customer-request-id> Nouveau

Pour utilisation future.

8 <method-of-payment> Modifié

Ajout d’un mode de paiement :
SupplierAccount = le paiement se fera par l’intermédiaire du compte de fournisseur désigné comme valeur par défaut dans le profil du client (offert uniquement aux fournisseurs de comptes de fournisseur).

Obtenir le manifeste (réponse) 8 <customer-request-id> Nouveau

Pour utilisation future.

Obtenir les détails du manifeste (réponse) 8 <supplier-account-receipt-details> Nouveau

Cette structure sera offerte si le manifeste a été payé par compte de fournisseur dans la demande Transmettre les envois.
Cette structure n’est pas retournée dans l’environnement « bac à sable ».

8 <merchant-name> Nouveau

La valeur sera la suivante : « Canada Post ».

8 <merchant-url> Nouveau

La valeur sera la suivante : « www.canadapost.ca ».

8 <auth-code> Nouveau

Le code d’autorisation reçu du fournisseur.

8 <auth-timestamp> Nouveau

La date et l’heure auxquelles le fournisseur a autorisé la transaction.

8 <supplier-id> Nouveau

Le fournisseur qui a autorisé la transaction. Les valeurs sont :

  • FP = FrancoTyp Postalia
  • NE = Neopost
  • PB = Pitney Bowes

8 <charge-amount> Nouveau

Le montant total facturé au compte.

8 <currency> Nouveau

La devise de la transaction; toujours CAD.

8 <transaction-type> Nouveau

La valeur sera la suivante : « Sale ».

Créer l'envoi (réponse) 7 <link> Nouveau

La réponse selon le module REST inclura le lien rel="refund". Ce lien s'affiche seulement pour les envois pour lesquels aucun manifeste n'est requis.

Obtenir les détails de l'envoi (réponse) 7 <refund-request-info> Nouveau

Cette structure est présente seulement si une demande de remboursement a été soumise pour l'envoi.

7 <service-ticket-date> Nouveau

Date à laquelle la demande de remboursement a été soumise

7 <service-ticket-id> Nouveau

Numéro de billet de service attribué à la demande de remboursement. Veuillez utiliser ce numéro dans toutes les communications que vous entretenez avec Postes Canada au sujet de cette demande de remboursement.

Obtenir les envois (demande) 7 <tracking-pin> Nouveau

Module SOAP : Ajout d'un nouveau NIP de repérage. Module REST : Ajout d'un paramètre de requête pour le NIP de repérage.

Créer l'envoi (demande) 7 <option-code> Modifié

Si vous choisissez l'option de contre remboursement (COD), l'option Annoncer par carte (HFP) ou l'option Livrer au bureau de poste (D2PO). La perception de fonds pour des envois contre remboursement est ainsi facilitée au bureau de poste. Si aucune option n'est choisie, le système sélectionnera par défaut l'option HFP.

7 <cod-remittance> Retiré

Retiré de la v7. Cet élément sera ignoré s'il est fourni dans les versions précédentes.

7 <option-qualifier-2> Modifié

Le mode de paiement pour les envois CR n'est plus requis.

Créer l'envoi (réponse) 7 <link> Modifié

La réponse selon le module REST n'inclura plus les liens suivants :

  • codRemittanceLabel
  • codRecordOfDelivery
  • codRemittanceReturnLabel

7 <artifact> Modifié

La réponse selon le module SOAP n'inclura plus d'élément artefact contenant :

  • codRemittanceLabel et
  • codRemittanceReturnLabel

Obtenir les détails de l'envoi (réponse) 7 <cod-remittance> Retiré

Cet élément n'est plus fourni. Les paiements CR sont maintenant traités par voie électronique.

Créer l'envoi (demande) 6 <encoding> Nouveau

{PDF, ZPL}

Servez-vous de ce champ pour préciser le format de sortie pour votre étiquette d'expédition : 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 » retourne des commandes rédigées dans le langage de programmation ZPL II. Vous devrez envoyer les commandes à votre imprimante thermique. Dans le module SOAP, les commande sont codées en base64.

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

{true}

Si vous avez des envois qui proviennent de l'extérieur du Canada, mais qui sont livrés directement à un établissement de Postes Canada, servez-vous de cet élément pour indiquer que ces envois sont un acheminement continu de marchandises d'arrivée (ACMA). Cette option vous permet d'être admissible à une exemption de la taxe de vente du Canada. Vous devrez fournir à Postes Canada des documents comprenant une preuve d'origine, tels qu'un document émis par les douanes canadiennes ou un connaissement.

Fournissez uniquement ce paramètre lorsque l'envoi est un ACMA (ne fournissez pas ce paramètre lorsque l'élément est réglé à « false »).
6 <quickship-label-requested> Nouveau

{true}

Utilisez cet élément si vous avez déjà un colis du régime intérieur indiquant le nom et l'adresse du destinataire, mais que vous voulez créer une étiquette supplémentaire aux fins de suivi. Aux fins de facturation, vous devez également fournir le <country-code> et les champs <postal-zip-code> dans la structure <destination>.

6 <requested-shipping-point> Modifié

Peut être utilisé pour indiquer le code postal de votre lieu de ramassage ou celui de votre lieu de dépôt.

Nota : Dans une version future, il sera obligatoire d'indiquer explicitement si votre envoi est ramassé par Postes Canada (en fournissant à la fois cet indicateur et l'élément <cpc-pickup-indicator>) ou déposé à un emplacement de Postes Canada (en fournissant l'élément « shipping-point-id »).

6 <cpc-pickup-indicator> Modifié

Passe de requis sous condition à optionnel.

Nota : Dans une version future, il sera obligatoire d'indiquer explicitement si votre envoi est ramassé par Postes Canada (en fournissant à la fois cet indicateur et l'élément <requested-shipping-point>).

6 <shipping-point-id> Modifié

Option s'excluant mutuellement avec <requested-shipping-point>

6 <name> Modifié

Si l'expédition se fait à l'extérieur du Canada, dans la structure <destination>, au moins un des champs <name> ou <company> est requis pour respecter les règlements douaniers internationaux.

N'est pas requis lorsque <quickship-label-requested> est réglé à
« true ».

6 <company> Modifié

Passe d'optionnel à requis sous condition.

Si l'expédition se fait à l'extérieur du Canada, dans la structure <destination>, au moins un des champs <name> ou <company> est requis pour respecter les règlements douaniers internationaux.

6 <address-line-1> Modifié

Passe d'optionnel à requis sous condition.

N'est pas requis lorsque <quickship-label-requested> est réglé à
« true »; obligatoire sinon.

6 <sku> Modifié

Passe d'un maximum de 44 caractères à un maximum de 15 caractères.

Nota : Les versions 1 à 5 de l'expédition avec convention permettront jusqu'à 44 caractères, mais les données seront tronquées à 15 caractères (afin de respecter les règlements douaniers).

Obtenir les détails de l'envoi (réponse) 6 <quickship-label-requested> Modifié

{true}

Affiché si fournit dans la demande de création d'un envoi.

Transmettre les envois 6 <requested-shipping-point> Modifié

Peut être utilisé pour indiquer le code postal de votre lieu de ramassage ou celui de votre lieu de dépôt.

Nota : Dans une version future, il sera obligatoire d'indiquer explicitement si votre envoi est ramassé par Postes Canada (en fournissant à la fois cet indicateur et l'élément <cpc-pickup-indicator>) ou déposé à un emplacement de Postes Canada (en fournissant l'élément <shipping-point-id>).

6 <cpc-pickup-indicator> Modifié Passe de requis sous condition à optionnel.
6 <shipping-point-id> Modifié Option s'excluant mutuellement avec <requested-shipping-point>.
Créer l'envoi (demande) 5 <requested-shipping-point> Modifié

Passe de « Requis » à « Requis sous condition ».

Code postal de l'emplacement où les envois sont ramassés par Postes Canada.

Ne doit être fourni que lorsque <cpc-pickup-indicator>=true.

Option s'excluant mutuellement avec <shipping-point-id>.

5 <cpc-pickup-indicator> Nouveau

Requis sous condition

Si vos envois sont ramassés par Postes Canada (ou par une tierce partie), réglez cet indicateur à « true » et saisissez le code postal de l'emplacement du ramassage dans le champ
<requested-shipping-point>.

Option s'excluant mutuellement avec <shipping-point-id>; cependant, l'une des deux doit être saisie.

5 <shipping-point-id> Nouveau

Requis sous condition

Si vous déposez vos envois à un emplacement de Postes Canada, fournissez le numéro d'emplacement de cet établissement. (Cherchez le numéro à l'aide de l'outil Trouver un lieu de dépôt.) Cette information est utilisée pour la tarification.

Option s'excluant mutuellement avec cpc-pickup-indicator; cependant, l'une des deux doit être saisie.

5 <duties-and-taxes-prepaid> Nouveau Réservé aux fins d'utilisation ultérieure.
5 <certificate-number> Nouveau

Optionnel

Si requis par les douanes du pays de destination, le numéro du certificat ou du permis du gouvernement ou de l'organisme.

5 <licence-number> Nouveau

Optionnel

Si requis par les douanes du pays de destination, le numéro de la licence d'importation ou d'exportation du gouvernement ou de l'organisme.

5 <invoice-number> Nouveau

Optionnel

Si requis par les douanes du pays de destination, le numéro de la facture commerciale.

5 <additional-customs-info> Retiré

Optionnel

De nouveaux champs ont été incorporés pour remplacer cette information.

5 <customs-unit-of-measure> Nouveau

Optionnel

Le code ISO à trois caractères qui identifie l'unité de mesure de votre article.

4 <group-id> Modifié

Passe de « Requis » à « Requis sous condition ».

L'élément group-id est requis, à moins que l'élément transmit-shipment soit fourni.

4 <transmit-shipment> Nouveau

Optionnel

{true}
Quand l'indicateur correspond à « true », le système transmettra immédiatement l'envoi au lieu d'attendre une demande ultérieure de service « Transmettre les envois ». Aucun manifeste n'est requis pour l'envoi.

Créer l'envoi (réponse) 4 rel=“receipt” Nouveau

Ce lien est utilisé pour accéder au reçu de la carte de crédit qui a été généré par le procédé « Créer l'envoi » lorsque
<transmit-shipment>=true.

Sollicite le service Web « Obtenir le reçu de l'envoi ».

Obtenir les détails de l'envoi (réponse) 5 <final-shipping-point> Modifié Si vous avez précisé un élément shipping-point-id dans votre demande de service « Créer l'envoi », il s'agit du code postal du lieu de dépôt que vous avez choisi.
5 <shipping-point-id> Il s'agit du numéro d'emplacement de Postes Canada pour le point d'expédition final.
5 <cpc-pickup-indicator> Affiché si vous avez mentionné que vos envois sont ramassés par Postes Canada à votre emplacement. N'est fourni que quand l'indicateur correspond à « true ».
5 <duties-and-taxes-prepaid> Nouveau Réservé aux fins d'utilisation ultérieure.
5 <certificate-number> Nouveau Numéro du certificat ou du permis du gouvernement ou de l'organisme pour les douanes.
5 <licence-number> Nouveau Numéro de la licence d'importation ou d'exportation du gouvernement ou de l'organisme pour les douanes.
5 <invoice-number> Nouveau Numéro de la facture commerciale pour les douanes.
5 <additional-customs-info> Retiré De nouveaux champs ont été incorporés pour remplacer cette information.
5 <customs-unit-of-measure> Nouveau Le code ISO à trois caractères qui identifie l'unité de mesure de votre article.
4 <po-number> Nouveau Il s'agit du numéro de commande de Postes Canada. Il ne s'applique et n'est affiché que pour un envoi portant la mention
<transmit-shipment>=true.
4 <transmit-shipment> Nouveau Ce champ est identique à l'élément correspondant dans la demande de création d'un envoi (s'excluant mutuellement avec group-id).
Obtenir les envois (demande) 4 n/a Nouveau Nouveau point final incorporé pour récupérer une liste des envois pour lesquels <transmit-shipment>=true: GET https://XX/rs/{mailed by customer}/{mobo}/shipment?noManifest=true&date=YYYYMMDD&limit={number}
Obtenir le reçu de l'envoi (NOUVEAU) 4 s.o. s.o.

S'applique seulement aux envois par carte de crédit pour lesquels
<transmit-shipment>=true.

Permet d'obtenir des renseignements relatifs au reçu d'une carte de crédit de la manière suivante :

  • REST : Utiliser le lien rel='receipt’ associé à une demande précédente de service « Créer l'envoi » ou à une réponse de service « Obtenir l'envoi » pour lequel
    <transmit-shipment>=true.
  • SOAP : Utiliser les données de la réponse à un appel au service « Obtenir le reçu de l'envoi » pour créer un reçu.
Transmettre les envois (demande) 5 <requested-shipping-point> Modifié

Passe de « Requis » à « Requis sous condition ».

Code postal de l'emplacement où les envois sont ramassés par Postes Canada.

Ne doit être fourni que lorsque <cpc-pickup-indicator>=true.

Option s'excluant mutuellement avec <shipping-point-id>.

5 <cpc-pickup-indicator> Nouveau

Requis sous condition

Si votre courrier est ramassé par Postes Canada (ou par une tierce partie), réglez cet indicateur à « true » et saisissez le code postal de l'emplacement du ramassage dans le champ <requested-shipping-point>.

Option s'excluant mutuellement avec <shipping-point-id>; cependant, l'une des deux doit être saisie.

5 <shipping-point-id> Nouveau

Requis sous condition

Si vous déposez vos envois à un emplacement de Postes Canada, fournissez le numéro d'emplacement de cet établissement. (Cherchez le numéro à l'aide de l'outil Trouver un lieu de dépôt.) Cette information est utilisée pour la tarification.

Option s'excluant mutuellement avec cpc-pickup-indicator; cependant, l'une des deux doit être saisie.

Obtenir les détails du manifeste (réponse) 5 <cpc-pickup-indicator> Nouveau Affiché si vous avez mentionné que votre courrier est ramassé par Postes Canada à votre emplacement. N'est fourni que quand l'indicateur correspond à « true ».
Catégorie « Expédition sans convention »
Créer l'envoi sans convention (demande) 4 <client-voice-number> Modifié

Mise à jour pour prendre en charge :

  • Un symbole d’addition (+), mais seulement tout au début de la chaîne de caractères.
  • Un point (.), un tiret (-), des parenthèses ou une espace suivie d’un « x » ou d’un « p » pour indiquer un numéro de poste.

4 <option-amount> Modifié

Ne pas fournir pour l’option COV dans le cas des envois à destination des États-Unis ou du régime international si vous voulez que le système calcule la couverture maximale permise (voir l’élément option-qualifier-1 ci-dessous).

4 <option-qualifier-1> Modifié

Mise à jour pour permettre l’utilisation avec l’option COV pour les envois à destination des États-Unis ou du régime international. Utiliser ce champ pour indiquer que le système peut appliquer le montant de la couverture maximale permise, qui devrait correspondre à la valeur totale de vos articles, jusqu’à la limite maximale permise pour le produit et le pays en question :

  • Vrai = Utiliser la couverture maximale permise; lorsqu’elle est utilisée, il n’est pas nécessaire de fournir option-amount.
  • Faux (par défaut) = Utiliser le montant de la couverture indiquée dans option-amount.

4 <currency> Modifié

Mise à jour pour valider que la devise est conforme à un code de devise ISO valide.

4 <reason-for-export> Modifié

GIF (cadeau) n’est plus une raison d’exportation valide, tel qu’il a été déterminé par l’Organisation mondiale des douanes pour les envois commerciaux.

4 <other-reason> Modifié

Mise à jour afin d’indiquer que ce champ doit contenir au moins quatre caractères (maximum de 40 caractères).

Créer l'envoi sans convention (réponse) 4 lien rel="label" Modifié

Le lien rel="label" s’affiche maintenant dans le format suivant : (/ers a été remplacé par /rs) : href="https://XX/rs/artifact/11111111/5555555/0" media-type="application/pdf" index="0">

Créer l'envoi sans convention (réponse) 4 <link> Modifié

La réponse selon le module REST inclura le lien rel="refund". Ce lien s'affiche seulement pour les envois pour lesquels aucun manifeste n'est requis.

Obtenir les détails de l'envoi sans convention (réponse) 4 <refund-request-info> Nouveau

Cette structure est présente seulement si une demande de remboursement a été soumise pour l'envoi.

4 <service-ticket-date> Nouveau

Date à laquelle la demande de remboursement a été soumise.

4 <service-ticket-id> Nouveau

Numéro d'identification du billet de service attribué à la demande de remboursement. Veuillez utiliser ce numéro dans toutes les communications que vous entretenez avec Postes Canada au sujet de cette demande de remboursement.

Obtenir les envois sans convention (demande) 4 <tracking-pin> Nouveau

Module SOAP : Ajout d'un nouveau NIP de repérage. Module REST : Ajout d'un paramètre de requête pour le NIP de repérage.

Créer l'envoi sans convention (demande) 4 <option-code> Modifié

Si vous choisissez l'option de contre remboursement (COD), l'option Annoncer par carte (HFP) ou l'option Livrer au bureau de poste (D2PO). La perception de fonds pour des envois contre remboursement est ainsi facilitée au bureau de poste. Si aucune option n'est choisie, le système sélectionnera par défaut l'option HFP.

4 <cod-remittance> Retiré

Retiré de la v4. Cet élément sera ignoré s'il est fourni dans les versions précédentes.

4 <option-qualifier-2> Modifié

Le mode de paiement pour les envois CR n'est plus requis.

Créer l'envoi sans convention (réponse) 4 <link> Modifié

La réponse selon le module REST n'inclura plus le lien suivant :

  • codRemittanceLabel

4 <artifact> Modifié

L'élément artefact du module REST ne comprendra plus ce qui suit :

  • codRemittanceLabel et
  • codRemittanceReturnLabel

Obtenir les détails de l'envoi sans convention (réponse) 4 <cod-remittance> Retiré

Cet élément n'est plus fourni. Les paiements CR sont maintenant traités par voie électronique.

Créer l'envoi sans convention (demande) 3 <requested-shipping-point> Modifié

Passe de requis à optionnel.

Requis si :

  • Votre envoi n'est pas ramassé par Postes Canada au code postal précisé dans la structure de l'expéditeur ci-dessous (c.-à-d. qu'il est ramassé à un autre emplacement).
  • Vous déposez votre envoi à un emplacement de Postes Canada. Dans ce cas, vous devez saisir le code postal de l'établissement.

3 <name> Modifié Si l'expédition se fait à l'extérieur du Canada, dans la structure <destination>, au moins un des champs <name> ou <company> est requis pour respecter les règlements douaniers internationaux.
3 <company> Modifié

Passe d'optionnel à requis sous condition.

Si l'expédition se fait à l'extérieur du Canada, dans la structure <destination>, au moins un des champs <name> ou <company> est requis pour respecter les règlements douaniers internationaux.

3 <sku> Modifié

Passe d'un maximum de 44 caractères à un maximum de 15 caractères.

Nota : Les versions 1 et 2 de l'expédition sans convention permettront jusqu'à 44 caractères, mais les données seront tronquées à 15 caractères (afin de respecter les règlements douaniers).

3 <settlement-info> Nouveau

Optionnel

Nouvelle structure sous <delivery-spec> contenant le nouvel élément <promo-code>.

3 <promo-code> Nouveau

Optionnel

Chaîne de caractères jusqu'à 10 caractères

Code de réduction promotionnelle

Converti en majuscules

Obtenir les détails de l'envoi sans convention (réponse) 3 <settlement-info> Nouveau Nouvelle structure sous <delivery-spec>. Contient le nouvel élément <promo-code>.
3 <promo-code> Nouveau Affiché si un <promo-code> valide est fourni dans la demande.
Créer l'envoi sans convention (demande) 2 <requested-shipping-point> Nouveau

Requis

Code postal de l'emplacement d'origine. Utilisé pour trouver le bureau de poste le plus près aux fins de tarification.

2 <duties-and-taxes-prepaid> Nouveau

Réservé aux fins d'utilisation ultérieure.

2 <certificate-number> Nouveau

Optionnel

Si requis par les douanes du pays de destination, le numéro du certificat ou du permis du gouvernement ou de l'organisme.

2 <licence-number> Nouveau

Optionnel

Si requis par les douanes du pays de destination, le numéro de la licence d'importation ou d'exportation du gouvernement ou de l'organisme.

2 <invoice-number> Nouveau

Optionnel

Si requis par les douanes du pays de destination, le numéro de la facture commerciale.

2 <additional-customs-info> Retiré De nouveaux champs ont été incorporés pour remplacer cette information.
2 <customs-unit-of-measure> Nouveau

Optionnel

Le code ISO à trois caractères qui identifie l'unité de mesure de votre article.

Obtenir les détails de l'envoi sans convention (réponse) 2 <final-shipping-point> Modifié Si vous avez précisé un élément shipping-point-id dans votre demande de service « Créer l'envoi sans convention », il s'agit du code postal du lieu de dépôt que vous avez choisi.
2 <duties-and-taxes-prepaid> Nouveau Réservé aux fins d'utilisation ultérieure.
2 <certificate-number> Nouveau Numéro du certificat ou du permis du gouvernement ou de l'organisme pour les douanes.
2 <licence-number> Nouveau Numéro de la licence d'importation ou d'exportation du gouvernement ou de l'organisme pour les douanes.
2 <invoice-number> Nouveau Numéro de la facture commerciale pour les douanes.
2 <additional-customs-info> Retiré De nouveaux champs ont été incorporés pour remplacer cette information.
2 <customs-unit-of-measure> Nouveau Le code ISO à trois caractères qui identifie l'unité de mesure de votre article.
Trouver un bureau de poste
Obtenir le bureau de poste le plus près 1 <tonight> Nouveau

Vrai | Faux

La mention « Vrai » indique que vous voulez une liste de bureaux de poste acceptant la livraison de colis assortis de l'option « Livrer au bureau de poste ». Peut également être utilisé pour le service « Livré ce soir » (c.-à-d. les bureaux de poste offrant des heures d'ouverture prolongée). Cet élément ne peut pas être « Vrai » lorsque « d2po » est « Faux ».
Envois retournés (retours génériques)
Créer un modèle générique pour les envois retournés (demande) 2 <output-format> Modifié

Modification permettant d’éliminer le format d’étiquette 3 po sur 5 po en juin 2016 (pendant une période provisoire, ces étiquettes seront tout de même acceptées et converties en étiquettes en format PDF de 4 po sur 6 po).

Créer un modèle générique pour les envois retournés (demande) 2 <encoding> Modifié

Modifié pour inclure la capacité d'imprimer des étiquettes du Service de retour sur du papier thermosensible de 4 po sur 6 po dans un format ZPL II.

{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 » retourne des commandes rédigées dans le langage de programmation ZPL II. Vous devrez envoyer les commandes à votre imprimante thermique. Dans le module SOAP, les commande sont codées en base64.

Le format ZPL est uniquement disponible sur du papier thermosensible, mais les étiquettes de 3 po sur 5 po ne sont pas encore disponibles. L'élément <output-format> doit alors être de 4 po sur 6 po.
Créer un modèle générique pour les envois retournés 2 <customer-input-type> Nouveau Créer des étiquettes du Service de retour qui contiennent un espace pour que vos clients saisissent des données. Ce champ ne s'applique qu'aux étiquettes de dimensions 4 po sur 6 po et 8,5 po sur 11 po. On n'en tiendra pas compte pour des étiquettes de dimensions 3 po sur 5 po.

Les valeurs acceptées sont les suivantes :
Code Description d'étiquette
INVOICE Invoice No / No de facture
ITEM Item No / No d’article
ORDER Order No / No de commande
PART Part No / No de pièce
PO PO No / No de bon de comm.
RETURN Return No / No de retour
RSA RSA No / No d’ARM
SERIAL Serial No / No de série
SKU SKU No / No UGS
Envois retournés (retours autorisés)
Créer un retour autorisé (demande) 2 <create-public-key> Nouveau

Optionnel
{true}
Si l'indicateur est présent et qu'il est réglé à « true », une d'URL publique sera générée pour qu'une version PDF de l'étiquette d'expédition soit récupérée et incluse dans la réponse au service avec la date d'expiration.

2 create-qr-code Nouveau

(true|false)

Si un indicateur est présent et qu’il est réglé à « true », ET que l’élément create-public-key a également cette valeur, l’encodage du code QR de l’URL publique est automatiquement généré et retourné dans la réponse.

2 customer-barcode Nouveau

(16 caractères alphanumériques)

Valeur du code à barres.

S’il est présent, le code à barres sera rendu dans la section de renseignements client de l’étiquette de retour autorisée (habituellement en bas).

2 customer-barcode-type Nouveau

(LINÉAIRE|2D)

Type de code à barres. Obligatoire si le code à barres du client est spécifié.

2 <output-format> Modifié

Modification permettant d’éliminer le format d’étiquette 3 po sur 5 po en juin 2016 (pendant une période provisoire, ces étiquettes seront tout de même acceptées et converties en étiquettes en format PDF de 4 po sur 6 po).

2 <weight> Modifié Passe de requis à optionnel.
2 <parcel-characteristics> Modifié Passe de requis à optionnel.
2 <encoding> Modifié

Modifié pour inclure la capacité d'imprimer des étiquettes du Service de retour sur du papier thermosensible de 4 po sur 6 po dans un format ZPL II.

{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 » retourne des commandes rédigées dans le langage de programmation ZPL II. Vous devrez envoyer les commandes à votre imprimante thermique. Dans le module SOAP, les commande sont codées en base64.

Le format ZPL est uniquement disponible sur du papier thermosensible, mais les étiquettes de 3 po sur 5 po ne sont pas encore disponibles. L'élément <output-format> doit alors être de 4 po sur 6 po.
Créer un retour autorisé (réponse) 2 <public-key-info> Nouveau

Nouvelle structure sous <delivery-spec> contenant le nouvel éléments <expiry-date> et <url>.

2 <expiry-date> Nouveau

La date d'expiration du URL publique de l'étiquette.

2 <url> Nouveau

URL pour récupérer la version PDF de l’étiquette.

2 customer-barcode Nouveau Valeur du code à barres spécifiée dans la demande (si elle est fournie).
2 qr-code Nouveau Encodage Base64 de l’image réelle du code QR qui représente l’URL publique (si create-qr-code et create-public-key sont tous deux présents dans la demande et réglés à « true »). – insérer le français.
Plates-formes de cybercommerce
Obtenir l’information sur l’inscription du commerçant (réponse) 2 < has-default-supplier-account> Nouveau

{true|false}

Indique si le commerçant a un compte de tiers par défaut figurant dans les dossiers de Postes Canada pouvant être utilisé pour les transactions d’expédition.

Si la valeur indique « Vrai », le commerçant peut effectuer ses transactions d’expédition à l’aide de cette méthode de paiement.

Si cette valeur et l’élément has-default-credit-card indiquent « Faux », le commerçant ne peut pas effectuer ses transactions d’expédition sans convention.

Remarque : Le compte de fournisseur comme mode de paiement est réservé aux fournisseurs.