Expédition sans convention

Exemples de codes pour l'expédition sans convention : Java (.zip) | PHP (.zip) | C# (.zip)

Créer l'envoi sans convention – Module REST

Résumé

Nom :

Créer l'envoi sans convention

Raison pour utiliser le service :

Pour permettre aux clients de Postes Canada sans convention commerciale de demander et de payer une étiquette d'expédition

Données d'entrée :

Détails de l'envoi et du paiement

Données de sortie :

Liens vers les détails de l'étiquette et du reçu

Exemple d'erreur :

Poids supérieur aux limites du service

Prochaine demande de service habituelle :

Obtenir l'artefact

Historique des versions : Notes de mise à jour
Résumé du service – Créer l'envoi sans convention

Résumé du service – Créer l'envoi sans convention

Détails sur la demande

Demande – Structure pour le service « Créer l'envoi sans convention »

Point final

POST https://XX/rs//{Client « Expédié par »}/ncshipment

Remplacez... Par...

XX (Conception)

ct.soa-gw.canadapost.ca

XX (Production)

soa-gw.canadapost.ca

{Client « Expédié par »}

Votre numéro de client

En-têtes HTTP

Variable des en-têtes HTTP

Valeur

Accept

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

Content-Type

application/vnd.cpc.ncshipment-v4+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 ou fr-CA

Corps du message

<?xml version="1.0" encoding="utf-8"?>
<non-contract-shipment xmlns="http://www.canadapost.ca/ws/ncshipment-v4">
xxx
</non-contract-shipment>

Demande – Éléments

Le tableau suivant décrit les éléments XML faisant partie des données d'entrée pour ce service. La structure hiérarchique des données d'entrée XML est présentée dans la section Demande – Diagramme XML.

Créer l'envoi sans convention – Éléments de la demande
Nom de l'élément Type Requis/Optionnel Description

non-contract-shipment

Complexe

Requis

Élément XML de niveau supérieur de la structure de la réponse.

requested-shipping-point

Simple

Optionnel

(Chaîne de six caractères alphanumériques)

Doit être dans un format de code postal valide.

Exemple : A9A9A9

Le format est « [A-Z]\d[A-Z]\d[A-Z]\d ».

Il s'agit du code postal de l'emplacement de l'expéditeur (origine). Utilisé pour trouver le bureau de poste le plus près aux fins de tarification.

Cet élément est 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. Recherchez le code postal à l'aide de la fonction Trouver un lieu de dépôt.

delivery-spec

Complexe

Requis

Cette structure comprend toute l'information nécessaire pour décrire la demande de livraison (l'envoi et sa destination).

service-code

Simple

Requis

Cette structure contient des données sur l'expéditeur et ces données correspondent à l'adresse de l'expéditeur figurant sur l'étiquette. Les champs vides seront retirés du formatage des adresses.

Il s'agit du service de livraison de Postes Canada utilisé pour expédier l'article.

Peut être l'un des services suivants :

Service-Code Description
Régime intérieur
DOM.RP Colis standard
DOM.EP Colis accélérés
DOM.XP Xpresspost
DOM.PC Priorité
États-Unis
USA.PW.ENV Enveloppe Priorité Mondial – É.-U.
USA.PW.PAK Paquet Priorité Mondial – É.-U.
USA.PW.PARCEL Colis Priorité Mondial – É.-U.
USA.XP Xpresspost É.-U.
USA.EP Colis accélérés É.-U.
USA.SP.AIR Petit paquet-avion à destination des É.-U.
USA.TP Paquet repérable – É.-U.
Régime international
INT.IP.AIR Colis-avion du régime international
INT.IP.SURF Colis de surface du régime international
INT.PW.ENV Enveloppe Priorité Mondial – International
INT.PW.PAK Paquet Priorité Mondial – International
INT.PW.PARCEL Colis Prioritié Mondial – International
INT.XP Xpresspost – International
INT.SP.AIR Petits paquets-avion du régime international
INT.SP.SURF Petits paquets de surface du régime international
INT.TP Paquet repérable – International

sender

Complexe

Requis

Cette structure contient des données sur l'expéditeur. Ces données correspondent à l'adresse de l'expéditeur figurant sur l'étiquette. Les champs vides seront retirés du formatage des adresses.

Remarque : l’adresse de l’expéditeur doit être du régime intérieur.

name

Simple

Optionnel

(Chaîne de caractères – Jusqu'à caractères)

Nom de l'expéditeur correspondant avec qui il faut communiquer.

company

Simple

Requis

(Chaîne de caractères – Jusqu'à 44 caractères)

Nom de l'entreprise de l'expéditeur correspondant.

contact-phone

Simple

Mandatory

(Chaîne de caractères – Jusqu'à 25 caractères)

Numéro de téléphone de l'expéditeur.

address-details

Complexe

Requis

Cette structure contient les données d'adressage de l'expéditeur.

Les champs vides seront supprimés au moment de l'impression sur les étiquettes d'expédition.

Remarque : l’adresse de l’expéditeur doit être du régime intérieur.

address-line-1

Simple

Requis

(Chaîne de caractères – Jusqu'à 44 caractères)

Ligne d'adresse 1 de l'expéditeur.

address-line-2

Simple

Optionnel

(Chaîne de caractères – Jusqu'à 44 caractères)

Ligne d'adresse 2 de l'expéditeur.

city

Simple

Requis

(Chaîne de caractères – Jusqu'à 40 caractères)

Ville de l'expéditeur.

prov-state

Simple

Requis

(Chaîne de caractères – Jusqu'à 2 caractères)

Province de l'expéditeur.

Utilisez les codes standards des provinces canadiennes.

postal-zip-code

Simple

Requis sous condition

(Six caractères alphanumériques)

Code postal de l'expéditeur.

Format [A-Z]\d[A-Z]\d[A-Z]\d

destination

Complexe

Requis

Cet élément doit toujours contenir l'adresse du destinataire du courrier, et ce, même si vous utilisez l'option « Livrer au bureau de poste ». Pour les envois réguliers, ces données s'afficheront dans l'adresse de destination figurant sur l'étiquette. Pour les envois assortis de l'option « Livrer au bureau de poste », le système remplacera l'adresse du bureau de poste sur l'étiquette. Les champs vides seront retirés pendant le formatage des adresses.

name

Simple

Requis sous condition

(Chaîne de caractères – Jusqu'à 44 caractères)

Nom du destinataire avec qui il faut communiquer.

Nota : Si l'option « Livrer au bureau de poste » est sélectionnée, l'élément
« name » doit être précisé pour la destination.

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

company

Simple

Requis sous condition

(Chaîne de caractères – Jusqu'à 44 caractères)

Nom de l'entreprise du destinataire.

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

additional-address-info

Simple

Optionnel

(Chaîne de caractères – Jusqu'à 44 caractères)

Données d'adressage supplémentaires pour la destination.

Si ces données sont présentes, elles seront imprimées directement au-dessus de la ligne d'adresse 1.

client-voice-number

Simple

Requis sous condition

(Chaîne de caractères – Jusqu'à 25 caractères)

Numéro de téléphone du destinataire. Il n'est pas requis pour les envois du régime intérieur et n'apparaîtra pas sur l'étiquette d'expédition.

Il est requis pour la destination lorsqu'il s'agit d'un colis ou d'un paquet du service Colis accélérés É.-U., Paquet repérable – É.-U., Xpresspost É.-U., Xpresspost – International, Paquet repérable – International ou Priorité Mondial.(USA.EP, USA.XP, USA.TP, INT.XP, INT.TP, USA.PW.PARCEL, USA.PW.PAK, INT.PW.PARCEL, INT.PW.PAK)

Il est également requis pour la destination lorsque l'option « Livrer au bureau de poste » est sélectionnée.

Remarque : En plus des chiffres, les caractères suivants sont acceptés dans ce champ :

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

address-details

Complexe

Requis

Cette structure contient les données d'adressage du destinataire.

Les champs vides seront supprimés au moment de l'impression sur les étiquettes d'expédition.

address-line-1

Simple

Requis

(Chaîne de caractères – Jusqu'à 44 caractères)

Ligne d'adresse 1 de la destination.

address-line-2

Simple

Optionnel

(Chaîne de caractères – Jusqu'à 44 caractères)

Ligne d'adresse 2 de la destination.

city

Simple

Requis sous condition

(Chaîne de caractères – Jusqu'à 40 caractères)

Requis pour les envois du régime intérieur et à destination des É.-U., mais optionnel pour les envois du régime international.

prov-state

Simple

Requis sous condition

(Chaîne de caractères – Jusqu'à 20 caractères)

Province ou État de la destination. Requis pour les envois du régime intérieur et à destination des É.-U., mais optionnel pour les envois du régime international.

Il faut utiliser l'un des codes suivants :

  • Code de province standard pour les provinces au Canada
  • Code d'état standard pour les États américains

country-code

Simple

Requis

(Code de pays valide à deux caractères)

Code de pays de la destination.

postal-zip-code

Simple

Requis sous condition

Peut être :

  • (Six caractères alphanumériques pour le Canada [A9A9A9])
    Format [A-Z]\d[A-Z]\d[A-Z]\d
  • (Code numérique à cinq chiffres ou à neuf chiffres [cinq chiffres suivis de quatre autres chiffres] pour les États-Unis) – Format \d{5}(-\d{4})?
  • Chaîne de caractères – Jusqu'à 14 caractères (tout format) pour les autres pays

Requis pour les destinations du régime intérieur et aux É.-U.

Code postal ou code ZIP du destinataire.

options

Complexe

Optionnel

Cette structure comprend des renseignements sur les options d'expédition demandées.

option

Complexe

Requis sous condition

Occurrence (1 à 20 fois).

Au moins une occurrence est nécessaire si l'élément XML parent correspondant
« options » existe.

Sélection d'une option d'expédition (p. ex. CR, couverture).

option-code

Simple

Requis sous condition

(Chaîne alphanumérique – Jusqu'à 10 lettres/chiffres)

Requis si l'élément XML parent correspondant « option » existe.

Il s'agit du code d'option indiquant l'option qui s'applique à l'envoi.

Les codes d'option valides sont les suivants :

SO – Signature
COV – Couverture
COD – Contre remboursement
PA18 – Preuve d'âge requise (18 ans)
PA19 – Preuve d'âge requise (19 ans)
HFP – Annoncer par carte
DNS – Ne pas laisser en lieu sûr
LAD – Laisser à la porte – Pas d'avis
D2PO – Livrer au bureau de poste

Nota : L'option « D2PO » indique que le colis sera livré directement à un bureau de poste proche. Les éléments XML suivants sont requis pour l'option « D2PO » :

  • name (sous destination)
  • client-voice-number (sous destination)
  • notification
  • option-qualifier-2

Remarque : 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.

Codes de traitement pour la non-livraison
(requis pour certains envois à destination des É.-U. et du régime international)
RASE – Retourner aux frais de l'expéditeur
RTS – Renvoi à l'expéditeur
ABAN – Abandon

option-amount

Simple

Requis sous condition

(Champ numérique de six chiffres, suivis de deux décimales [p. ex. format 999999.99])

Requis si l'élément XML parent correspondant « option » existe, selon la valeur du code d'option.

Requis pour certaines options, notamment la couverture (COV) et l'option CR.

Remarque : Le montant maximal des envois CR est fixé à 1 000 $ (y compris les frais d’expédition, le cas échéant) pour les clients des Solutions pour petites entreprises.

Ne pas fournir pour 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).

option-qualifier-1

Simple

Requis sous condition

Attribut booléen – {vrai, faux}

Peut être utilisé pour fournir un qualificatif pour les options CR ou COV.

Pour indiquer si le montant du paiement CR comprend les frais d’expédition ou non :

  • Vrai = Les frais d’expédition seront ajoutés au montant CR que vous avez indiqué dans <option-amount>.
  • Faux = Le montant CR à percevoir est indiqué dans <option-amount> (c.-à-d. que les frais d’expédition ne seront pas ajoutés).

À utiliser avec l’option COV pour les envois à destination des États-Unis ou du régime international 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.

Si le qualificatif n’est pas fourni, l’attribut « Faux » est sélectionné par défaut.

option-qualifier-2

Simple

Requis sous condition

{Chaîne de caractères – Jusqu'à 12 caractères}

Requis si l'élément XML parent correspondant « option » existe et qu'un deuxième qualificatif est nécessaire pour le code d'option.

Ce qualificatif est disponible pour toutes les options pouvant nécessiter un deuxième qualificatif. À l'heure actuelle, les options nécessitant un deuxième qualificatif sont les suivants :

Livrer au bureau de poste
Pour l'option « Livrer au bureau de poste », cet élément doit contenir le numéro d'identification du bureau de poste de destination.

parcel-characteristics

Complexe

Requis

Cette structure décrit les caractéristiques du colis (p. ex. poids).

weight

Simple

Requis

(Champ numérique de trois chiffres, suivis de trois décimales [p. ex. format 999.999])

Poids total du colis en kilogrammes.

dimensions

Complexe

Requis sous condition

Cette structure contient les dimensions physiques du colis qui sont utilisées pour déterminer les frais d'expédition de façon plus précise.

Ce groupe est requis, à moins que l'envoi soit un document.

length

Simple

Requis sous condition

(Champ numérique de trois chiffres, suivis d'une décimale [p. ex. format 999.9])

Longueur du colis en centimètres.

Requis si l'élément XML parent correspondant « dimensions » existe.

Si la longueur est précisée, un prix plus exact peut être défini. La valeur est indiquée en centimètres.

width

Simple

Requis sous condition

(Champ numérique de trois chiffres, suivis d'une décimale [p. ex. format 999.9])

Largeur du colis en centimètres.

Requis si l'élément XML parent correspondant « dimensions » existe.

Si la largeur est précisée, un prix plus exact peut être défini.

height

Simple

Requis sous condition

(Champ numérique de trois chiffres, suivis d'une décimale [p. ex. format 999.9])

Hauteur du colis en centimètres.

Requis si l'élément XML parent correspondant « dimensions » existe.

Si la hauteur est précisée, un prix plus exact peut être défini.

document

Simple

Optionnel

{vrai, faux}

Indique si l'envoi est un document ou non. (Si cette valeur est omise ou « Faux », les dimensions sont requises.)

unpackaged

Simple

Optionnel

{vrai, faux}

Indique si un envoi est emballé ou non. Par exemple, les pneus d'une voiture peuvent constituer un envoi non emballé.

mailing-tube

Simple

Optionnel

{vrai, faux}

Indique si un envoi est inséré dans un tube d'expédition (p. ex. tube contenant une affiche).

notification

Complexe

Requis sous condition

Cette structure comprend les préférences des clients quant à la fonction d'avis électronique pour les activités de suivi (p. ex. livraison).

Cet élément est requis si l'option « Livrer au bureau de poste » (D2PO) a été sélectionnée. Pour la livraison au bureau de poste, le courriel désigné dans l'élément « notification » sera utilisé pour aviser le client qu'il peut ramasser son colis.

email

Simple

Requis sous condition

(Chaîne de caractères – Jusqu'à 60 caractères)

Il doit s'agir d'une adresse électronique valide.

Format (['_A-Za-z0-9\-\+])(\.['_A-Za-z0-9\-\+])@([A-Za-z0-9-])(\.[A-Za-z0-9-])(\.[A-Za-z]{2,})

Cet élément est obligatoire si l'élément « notification » existe.

Adresse électronique pour recevoir des mises à jour de suivi automatiques.

on-shipment

Simple

Requis sous condition

{true, false}

Cet élément est obligatoire si l'élément « notification » existe.

Indique si le client souhaite recevoir un avis électronique concernant un envoi.

on-exception

Simple

Requis sous condition

{vrai, faux}

Cet élément est obligatoire si l'élément « notification » existe.

Indique si le client souhaite recevoir un avis électronique concernant un envoi.

on-delivery

Simple

Requis sous condition

{vrai, faux}

Cet élément est obligatoire si l'élément « notification » existe.

Indique si le client souhaite recevoir un avis électronique concernant un envoi.

preferences

Complexe

Requis

Cette structure comprend un certain nombre de préférences des clients en ce qui a trait à l'impression des étiquettes.

show-packing-instructions

Simple

Requis

{vrai, faux}

Cet élément indique si les directives d'emballage doivent être inscrites sur l'étiquette ou non.

show-postage-rate

Simple

Optionnel

{vrai, faux}

Cet élément indique si le tarif postal doit être inscrit sur l'étiquette ou non.

Il s'applique seulement aux envois à destination des États-Unis et du régime international.

Si cet élément n'est pas précisé, la valeur « Faux » s'affiche par défaut.

show-insured-value

Simple

Optionnel

{vrai, faux}

Cet élément indique si la valeur assurée doit être inscrite sur l'étiquette ou non.

Il s'applique seulement aux envois à destination des États-Unis et du régime international.

Si cet élément n'est pas précisé, la valeur « Faux » s'affiche par défaut.

references

Complexe

Optionnel

Cette structure contient des champs de référence que vous pouvez attribuer. Ces autres numéros d'identification (pouvant être uniques) sont attribués à l'envoi pour une raison quelconque utile pour vous.

cost-centre

Simple

Optionnel

(Chaîne de caractères – Jusqu'à 30 caractères)

Il s'agit d'une valeur définie par l'utilisateur disponible pour vos applications. La valeur que vous saisissez ici apparaîtra sur votre facture et dans le courriel sécurisé PosteCS que nous utilisons pour envoyer votre facture.

customer-ref-1

Simple

Optionnel

(Chaîne de caractères – Jusqu'à 35 caractères)

Il s'agit d'une valeur définie par l'utilisateur disponible pour vos applications (p. ex. vous pourriez utiliser ce champ pour le numéro d'identification d'une commande interne). La valeur que vous saisissez ici apparaîtra sur l'étiquette d'expédition, dans l'outil Repérer et, pour les clients qui sont inscrits à notre service de suivi automatisé des colis, dans votre fichier SAC.

customer-ref-2

Simple

Optionnel

(Chaîne de caractères – Jusqu'à 35 caractères)

Il s'agit d'une valeur définie par l'utilisateur disponible pour vos applications. La valeur que vous saisissez ici apparaîtra sur l'étiquette d'expédition, dans l'outil Repérer et, pour les clients qui sont inscrits à notre service de suivi automatisé des colis, dans votre fichier SAC.

customs

Complexe

Optionnel

Cette structure comprend des renseignements qui doivent être imprimés sur l'étiquette pour faciliter le dédouanement transfrontalier.

currency

Simple

Requis sous condition

(Chaîne de caractères – Trois caractères alphabétiques )

La valeur doit être :

  • « CAD » pour une devise canadienne;
  • « USD » pour une devise américaine;
  • Autre code de devise ISO valide

Requis si l'élément XML parent correspondant « customs » existe.

Il s'agit de la devise du pays de destination.

conversion-from-cad

Simple

Requis sous condition

(Champ numérique de trois chiffres, suivis de trois décimales [p. ex., format 999.999])

Requis si l'élément XML parent correspondant « customs » existe et si la devise n'est pas canadienne.

Le taux de conversion du dollar canadien à la devise que vous avez entrée dans l’élément de devise ci-dessus; par exemple, si vous entré les dollars américains comme devise cible et que 1,00 $ CAD = 0,85 $ US, le taux de conversion est de 0,85.

reason-for-export

Simple

Requis sous condition

(Trois caractères)

Requis si l'élément XML parent correspondant « customs » existe.

Il s'agit d'un code représentant la raison de l'exportation, lequel facilite le passage transfrontalier.

Voici les codes et leurs significations :

DOC = Document
SAM = Échantillon commercial
REP = Réparation ou garantie
SOG = Vente de biens
OTH = Autre

other-reason

Simple

Optionnel

(Chaîne de caractères – Minimum de quatre caractères; maximum de 44 caractères)

Il s'agit de la raison de l'exportation si l'élément reason-for-export la décrivant est
« Autre ».

duties-and-taxes-prepaid

Simple

Optionnel

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

certificate-number

Simple

Optionnel

(Chaîne de caractères – Jusqu'à 10 caractères)

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

licence-number

Simple

Optionnel

(Chaîne de caractères – Jusqu'à 10 caractères)

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.

invoice-number

Simple

Optionnel

(Chaîne de caractères – Jusqu'à 10 caractères)

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

ioss-id

simple

optionnel

(Chaîne de caractères – Jusqu'à 13 caractères)

Champ facultatif pour la saisie des numéros ou ID d’inscription à l’impôt (p. ex., ID d’inscription à l’impôt, numéro IRS, TVA, numéro IOSS) aux fins de transmission électronique au poste de réception. Remarque : Le numéro IOSS doit être saisi selon le format « IMxxxxxxxxxx ».

sku-list

Complexe

Requis sous condition

S'il existe un élément parent douanier correspondant, cet élément est obligatoire.

Cette structure contient la liste de types d'articles uniques inclus dans cet envoi ainsi que les renseignements connexes.

Une quantité de un ou plus peut être associée à chaque type d'article. Ces renseignements sont imprimés sur l'étiquette ou sur le document douanier pour faciliter le traitement des colis aux douanes.

item

Complexe

Requis

Occurrence (1 à 500 fois)

Il doit y avoir au moins une occurrence pour l'envoi.

Il y a une limite de 500 éléments pour une sku-list.

Cette structure contient les renseignements sur le type d'article (nombre d'unités, valeur par unité, etc.) que comprend l'envoi.

hs-tariff-code

Simple

Optionnel

(Champ numérique de format général 9999.99.99.99)

Le format est \d{4}(\.\d{2}(\.\d{2}(\.\d{2})?)?)?.

Code de tarification de l'article

sku

Simple

Optionnel

(Chaîne de caractères – Jusqu'à 15 caractères)

Nom ou numéro de l'article aux fins de dédouanement

Nota : La version 3 permet seulement un maximum de 15 caractères. Les versions précédentes permettent un maximum de 44 caractères, mais les données seront tronquées en 15 caractères. Les limites de longueur sont nécessaires à des fins de conformité aux règlements douaniers internationaux.

customs-description

Simple

Requis sous condition

(Chaîne de caractères – Jusqu'à 45 caractères)

Requis si l'élément XML parent correspondant «item » existe.

Description pour douanes de l'article.

unit-weight

Simple

Requis sous condition

(Champ numérique de trois chiffres, suivis de trois décimale [p. ex. format 999.999])

Requis si l'élément XML parent correspondant « item » existe.

Poids unitaire de l'article en kilogrammes

customs-value-per-unit

Simple

Requis sous condition

(Champ numérique de cinq chiffres, suivis de deux décimales [p. ex. format 99999.99])

Requis si l'élément XML parent correspondant « item » existe.

Valeur unitaire de l'article en devise canadienne

customs-number-of-units

Simple

Requis sous condition

(Champ numérique de quatre chiffres [p. ex. format 9999])

Requis si l'élément XML parent correspondant « item » existe.

Nombre d'unités dans le colis

customs-unit-of-measure

Simple

Optionnel

(Code de pays ISO à trois caractères)

Indique l'unité de mesure pour l'élément customs-number-of-units.

  • PCE – Article
  • NMB – Numéro
  • PAR – Paire
  • PKG – Paquet
  • ENV – Enveloppe
  • LTR – Litre
  • MLT – Millilitre
  • BOX – Boîte
  • BAG – Sac
  • MTR – Mètre
  • MMT – Millimètre
  • DZN – Douzaine
  • GRM – Gramme
  • KGM – Kilogramme
  • CTN – Carton
  • BIN – Bac
  • SET – Nombre de séries
  • BOT – Bouteille
  • TBE – Tube
  • KIT – Trousse

country-of-origin

Simple

Optionnel

(Code de pays valide à deux caractères)

Il s'agit du pays d'origine de l'article correspondant et il doit être fourni si l'élément XML parent correspondant « item » existe (et si le pays d'origine est connu).

Si le pays d'origine n'est pas connu, l'élément peut être omis.

province-of-origin

Simple

Requis sous condition

(Code de province valide à deux caractères)

Obligatoire si le pays d'origine est le Canada.

Province d'origine des biens

settlement-info

Complexe

Optionnel

Structure comprenant des éléments liés au paiement ou à la tarification.

promo-code

Simple

Optionnel

Chaîne de caractères – Jusqu'à 10 caractères.

Code de réduction promotionnelle. Veuillez noter qu'un code de promotion est uniquement valide pour un certain produit et pendant une certaine période.

Converti en majuscules.

Aux fins de mise à l'essai, vous pouvez utiliser le code de promotion DEVPROTEST dans l'environnement de développement (« Bac à sable »). Il est valide pour les produits suivants :

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

Demande – Diagramme XML

Créer l'envoi sans convention – Structure de la demande XML
Créer l'envoi sans convention – Structure de la demande XML

Détails de la réponse

Réponse – Éléments

Le tableau suivant décrit les champs XML dans la réponse. Pour obtenir un aperçu détaillé de la hiérarchie de la réponse, consultez le diagramme ci-dessous.

Créer l'envoi sans convention – Éléments de la réponse
Nom de l'élément Type Description

non-contract-shipment-info

Complexe

Niveau supérieur de la structure XML.

shipment-id

Simple

Il s'agit d'un numéro d'identification unique pour l'envoi. Il peut être utilisé pour toute demande future concernant le service Transmettre les envois afin de préciser que cet envoi doit être exclu du transfert.

tracking-pin

Simple

Il s'agit du numéro d'identification du produit (NIP) pour l'envoi. Le NIP de repérage peut être utilisé en tant que donnée d'entrée pour toute autre demande de service pour les colis, notamment le service « Obtenir les détails de repérage ».

links

Complexe

Cette structure représente une liste de liens vers les renseignements concernant l'envoi créé.

link

Complexe

Occurrence (1 à N fois).

(Nota : Le lien de l'élément XML est désigné comment étant « Complexe » parce qu'il comprend un certain nombre d'attributs et, selon la définition officielle de XML, tout élément qui comprend des attributs est complexe. L'élément de lien ne comprend aucun sous-élément.)

La structure des liens comprend un certain nombre d'éléments de lien. Ces éléments vous permettent de récupérer séparément les différents résultats du service « Créer l'envoi sans convention » et d'utiliser différentes fonctions supplémentaires pour l'envoi créé. Chaque lien représente un lien vers l'un des services en ligne.

Consultez la section Points finaux fournis pour obtenir une description des attributs des liens.

Plusieurs liens s'afficheront. Un type unique de rel sera associé à chacun d'eux.

  1. rel="self"
  2. Indique que le lien représente l'envoi qui vient tout juste d'être créé. Dans ce cas, l'attribut « href » peut être utilisé comme point final propre au service « Obtenir l'envoi sans convention » pour l'envoi créé. (Consultez la section Obtenir l'envoi sans convention pour obtenir des renseignements sur la façon de présenter une demande pour ce service.) Étant donné que les renseignements liés au service « Obtenir l'envoi sans convention » sont les mêmes que ceux du service « Créer l'envoi sans convention », il est possible d'utiliser cet élément pour générer de nouveau (plus tard) tous les renseignements fournis pour le service « Créer l'envoi sans convention ».
    L'attribut lié au type de média désignera la version du format XML qu'il faut respecter en présentant une demande de service « Obtenir l'envoi sans convention ».

  1. rel = "label"
  2. Désigne le lien vers l'étiquette d'expédition (sortie). (Consultez la section Obtenir l'artefact pour obtenir des renseignements sur la façon de présenter une demande pour ce service.) L'attribut lié au type de média désignera le format du fichier graphique (PDF).
    Nota : Pour les liens de type « rel="label" », l'attribut supplémentaire « index="n" » (p. ex.
    « index="0" ») est aussi requis. Il convient à une situation où une étiquette de plusieurs pages est apposée sur un certain nombre d'artefacts distincts (une pour chaque page). Dans la plupart des cas, il y aura seulement une page, alors l'attribut « index="0" » sera utilisé.

  1. rel = "commercialInvoice"
  2. Il existe seulement dans le cas d'un envoi à destination des États-Unis ou du régime international pour lequel il faut présenter une facture commerciale aux douanes.
    (Consulter la section Obtenir l'artefact pour obtenir des renseignements sur la façon de récupérer l'étiquette). L'attribut lié au type de média désignera le format du fichier (p. ex. PDF).

  1. rel = "details"
  2. Cela signifie que le lien fournira des détails supplémentaires produits dans le cadre du procédé de création d'un envoi sans convention. (Consultez la section Obtenir les détails de l'envoi sans convention pour obtenir des renseignements sur la façon de présenter une demande pour ce service.) L'attribut lié au type de média désigne la version du fichier XML qui s'affichera.

  1. rel = "receipt"
  2. Cela signifie que le lien fournira des détails sur le prix et le reçu produits dans le cadre du procédé de création d'un envoi sans convention. (Consultez la section Obtenir le reçu de l'envoi sans convention pour obtenir des renseignements sur la façon de présenter une demande pour ce service.) L'attribut lié au type de média désigne la version du fichier XML qui s'affichera.

  1. rel = "refund"
  2. Utilisez ce lien pour faire une demande de remboursement pour cet envoi grâce à la demande de remboursement d'un envoi sans convention. Vous ne pouvez demander de remboursement que si l'envoi a été transmis et que vous avez imprimé une étiquette qui est abîmée ou qui ne sera pas utilisée pour une raison ou une autre.

    L'attribut lié au type de média désigne la version du fichier XML qui s'affichera.

    Dans tous les cas susmentionnés, la valeur de l'attribut media-type doit être incluse dans l'en-tête HTTP Accept lorsqu'il faut présenter toute autre demande de service désignée par l'attribut « href ».

Réponse – Diagramme XML

Le diagramme suivant présente la structure de données XML de la réponse pour le service « Créer l'envoi sans convention ».

Créer l'envoi sans convention – Structure de la réponse XML

Créer l'envoi sans convention – Structure de la réponse XML

Réponse – Réponses d'erreur possibles

Voici des réponses d'erreur possibles :

Code

Description

1459

La valeur du code de la raison de l’exportation n’est pas valide. (Remarque : À compter du mois d’avril 2016, l’option de cadeau n’est plus valide.)

1719

Le montant de la couverture ne doit pas excéder la valeur totale de vos articles, et ce, jusqu’à la limite maximale permise pour le produit et le pays en question.

7272

Le code de promotion n'est pas valide (n'existe pas ou ne s'applique pas au service sélectionné).

7282

Au moins un nom de destinataire ou un nom d'entreprise est requis conformément aux règlements douaniers.

7289

Le service sélectionné n'est pas valide pour le client ou le contrat indiqué.

7322

Le code de devise n’est pas un code de devise ISO à trois caractères valide (comme USD).

Consultez également les sections Codes de statut HTTP et Messages d'erreur et stratégies d'atténuation.

Exemples

Exemple de demande XML selon le module REST – Créer l'envoi sans convention

<non-contract-shipment>
<requested-shipping-point>J8R1A2</requested-shipping-point>
<delivery-spec>
<service-code>DOM.EP</service-code>
<sender>
<company>Canada Post Corporation</company>
<contact-phone>555-555-5555</contact-phone>
<address-details>
<address-line-1>2701 Riverside Drive</address-line-1>
<city>Ottawa</city>
<prov-state>ON</prov-state>
<postal-zip-code>K1A0B1</postal-zip-code>
</address-details>
</sender>
<destination>
<name>John Doe</name>
<company>Consumer</company>
<address-details>
<address-line-1>2701 Receiver Drive</address-line-1>
<city>Ottawa</city>
<prov-state>ON</prov-state>
<country-code>CA</country-code>
<postal-zip-code>K1A0B1</postal-zip-code>
</address-details>
</destination>
<options>
<option>
<option-code>DC</option-code>
</option>
</options>
<parcel-characteristics>
<weight>15</weight>
<dimensions>
<length>1</length>
<width>1</width>
<height>1</height>
</dimensions>
</parcel-characteristics>
<preferences>
<show-packing-instructions>true</show-packing-instructions>
</preferences>
</delivery-spec>
</non-contract-shipment>

Exemple de réponse XML selon le module REST – Créer l'envoi sans convention

<non-contract-shipment-info>
<shipment-id>406951321983787352</shipment-id>
<tracking-pin>12345678901234</tracking-pin>
<links>
<link rel="self" href="https://ct.soa-gw.canadapost.ca/rs/0007023211/ncshipment/406951321983787352" media-type="application/vnd.cpc.ncshipment-v4+xml"></link>
<link rel="details" href="https://ct.soa-gw.canadapost.ca/rs/0007023211/ncshipment/406951321983787352/details" media-type="application/vnd.cpc.ncshipment-v4+xml"></link>
<link rel="receipt" href="https://ct.soa-gw.canadapost.ca /rs/0007023211/ncshipment/406951321983787352/receipt"media-type="application/vnd.cpc.ncshipment-v4+xml"></link>
<link rel="label" href="https://ct.soa-gw.canadapost.ca/rs/artifact/76108cb5192002d5/10238/0" media-type="application/pdf" index="0"></link>
</links>
</non-contract-shipment-info>