Demande – Champs

Nom du champ

Type

Requis/Facultatif

Description

customerNumber

Chaîne de caractères

Requis sous condition

Numéro de client du propriétaire du courrier (Expédié au nom de)

(Format numérique – Jusqu'à 10 chiffres)

Ce champ est exigé pour obtenir des tarifs réduits pour les clients commerciaux et les clients du programme Solutions pour petites entreprises. Il faut l'omettre pour obtenir les tarifs au comptoir (c.-à-d. tarifs des particuliers).

expectedMailingDate

Chaîne de caractères

Facultatif

Date d'expédition prévue pour le colis

Cette date est utilisée pour calculer la date de livraison prévue. Cependant, toutes les propositions tarifaires sont fonction de la date actuelle du système.

(Format de la date : AAAA-MM-JJ)

quoteType

Chaîne de caractères

Facultatif

Option « Commercial » ou « Counter »

L’option « Commercial » remettra le tarif réduit en place pour le client commercial ou le client du programme Solutions pour petites entreprises.
Si l'option « Counter » est sélectionnée, le prix courant payé par les consommateurs s'affiche.

L'option « Commercial » s'affiche par défaut si aucune option n'est sélectionnée.

contractId

Chaîne de caractères

Requis sous condition

Ce champ est exigé pour obtenir des tarifs réduits pour les clients commerciaux lorsque le numéro de client n'est pas fourni. Il faut omettre le numéro d'identification de la convention pour les clients du programme Solutions pour petites entreprises ou les utilisateurs commerciaux généraux.

(Format numérique – Jusqu'à 10 chiffres)

options

Tableau d'objets

Requis

Structure contenant la liste d'options voulues pour l'envoi

optionCode

Chaîne de caractères

Requis

(10 caractères alphanumériques)

Comprend le code d'option propre à Postes Canada.

Valeurs valides :

SO – Signature
COV – Couverture (qualificatif requis)
COD – CR (qualificatif requis)
PA18 – Preuve d'âge requise (18 ans)
PA19 – Preuve d'âge requise (19 ans)
PA21 – Preuve d'âge requise (21 ans)
HFP – Annoncer par carte
DNS – Ne pas laisser en lieu sûr
LAD – Laisser à la porte – Pas d'avis

optionAmount

Nombre

Requis (selon le code d'option)

Requis pour COV – Montant de l'assurance à acheter

Cinq chiffres, suivis de deux décimales (p. ex. 99999.99)

parcelCharacteristics

Objet

Requis

Détails liés au colis (p. ex. poids, dimensions et apparence)

weight

Nombre

Requis

Poids du colis en kilogrammes

(99.999)

Fait partie des parcelCharacteristics.

dimensions

Object

Facultatif

Détails liés aux dimensions du colis en centimètres.

length

Nombre

Requis

Dimension la plus longue

(Trois chiffres, suivis d'une décimale [p. ex. format 999.9])

width

Nombre

Requis

Deuxième plus longue dimension

(Trois chiffres, suivis d'une décimale [p. ex. format 999.9])

height

Nombre

Requis

Dimension la plus courte

(Trois chiffres, suivis d'une décimale [p. ex. format 999.9])

unpackaged

Booléen

Facultatif

vrai | faux

La valeur par défaut est « faux ».
La mention « vrai » signifie que le colis ne sera pas emballé (p. ex. pneus).

mailingTube

Booléen

Facultatif

vrai | faux

La valeur par défaut est « faux ».
La mention « vrai » signifie que l'objet sera expédié dans un tube d'expédition.

oversized

Booléen

Facultatif

vrai | faux

La valeur par défaut est « faux ».
La mention « vrai » signifie que l'objet est surdimensionné.
La valeur est définie correctement si les dimensions sont fournies.

services

Tableau de chaînes de caractères

Facultatif

Précise les services pour lesquels il faut déterminer le tarif pour ce scénario d'expédition.

serviceCode

Chaîne de caractères

Requis

Occurrence (1 à 20 fois)

Le tarif doit être déterminé pour un service précis. Si aucun serviceCode n'est inclus dans la demande, le tarif sera déterminé pour tous les services liés à l'envoi et à la destination, puis l'envoi sera retourné.

Code	Description
DOM.RP	Colis standard
DOM.EP	Colis accélérés
DOM.XP	Xpresspost
DOM.XP.CERT	Xpresspost certifié
DOM.PC	Priorité
DOM.LIB	Documents de bibliothèque
USA.EP	Colis accélérés É.-U.
USA.SP.AIR	Petits paquets-avion à destination des É.-U.
USA.TP	Paquet repérable – É.-U.
USA.TP.LVM	Paquet repérable – É.-U. (GEC) (gros expéditeur de courrier)
USA.XP	Xpresspost É.-U.
INT.XP	Xpresspost International
INT.IP.AIR	Colis-avion du régime international
INT.IP.SURF	Colis de surface du régime 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

originPostalCode

Chaîne de caractères

Requis

Code postal à partir duquel le colis sera envoyé.

Format ANANAN (seulement accepté avec majuscules)

destination

Objet

Requis

Définit la destination du colis.

domestic

Objet

Choix

Définit la destination au Canada.

postalCode

Chaîne de caractères

Requis

Code postal de destination.

Format ANANAN (seulement accepté avec majuscules)

unitedStates

Objet

Choix

Définit la destination aux États-Unis.

zipCode

Chaîne de caractères

Requis

Il est utilisé lorsque le code de pays est « US ». Le format est de cinq chiffres ou de cinq chiffres suivis de quatre autres chiffres (pour les codes ZIP prolongés).

Exemple : 12345 ou 12345-6789

international

Objet

Choix

Il s'agit de la destination internationale (destination autre que les États-Unis ou le Canada). Seule une destination (internationale, États-Unis ou régime intérieur) peut être précisée.

countryCode

Chaîne de caractères

Requis

Code de pays de destination – Code de pays standard à deux caractères (code de pays valide autre que CA ou US).

postalCode

Chaîne de caractères

Requis

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