Expédition avec convention
Créer l'envoi – Module REST
Résumé
Nom : | Créer l'envoi |
---|---|
Raison pour utiliser le service : | Entamer la production d'une étiquette d'expédition en fournissant les détails sur l'envoi. L'utilisation de ce service indique l'intention de payer pour l'expédition d'un article. |
Données d'entrée : | ID du groupe pour le regroupement de manifestes, codes postaux d'origine et de destination, service d'expédition demandé, caractéristiques de l'envoi, options et préférences. |
Données de sortie : | Liens vers toute l'information associée à l'envoi créé, y compris les numéros d'identification du produit (NIP) aux fins de suivi. Ces liens resteront accessibles au client pendant une période déterminée (actuellement 90 jours) ou jusqu'à ce que l'envoi soit annulé par le client. |
Exemple d'erreur : | Pays invalide ou poids dépassant 30 kg |
Demande de service précédente habituelle : | |
Prochaine demande de service habituelle : | |
Prochaine demande de service optionnelle : | Obtenir le tarif de l'envoi et Obtenir les détails de l'envoi |
Demandes de service obligatoires pour terminer le procédé d'expédition : |
Transmettre les envois – À moins que votre demande de création d'un envoi comprenne l'élément transmit-shipment, qui indique un envoi pour lequel un manifeste n'est pas requis à titre de preuve de paiement, le procédé d'expédition n'est pas terminé jusqu'à ce que vous fassiez une demande de service « Transmettre les envois ». Le service « Transmettre les envois » envoie les données d'expédition aux fins de facturation et de suivi à Postes Canada et vous fournit les renseignements nécessaires pour obtenir un manifeste (votre copie papier de la preuve de paiement est requise pour tous les envois aux fins de dépôt ou de ramassage à Postes Canada). Nous contrôlons tous les envois pour lesquels ce procédé n'a pas été suivi. Le non-respect de cette consigne entraînera une facturation manuelle au plein tarif et/ou la perte de votre réduction à l'automatisation. Pour imprimer votre manifeste, utilisez les renseignements fournis en réponse au service « Transmettre les envois » pour faire appel au service Obtenir le manifeste, puis au service Obtenir l'artefact. |
Historique des versions : |
Détails sur la demande
Structure de la demande pour créer l'envoi
Point final
POST https://XX/rs/{Client « Expédié par »}/{Client « Expédié au nom de »}/shipment |
|
---|---|
Remplacez... | Par... |
XX (développement) |
ct.soa-gw.canadapost.ca* |
XX (production) |
soa-gw.canadapost.ca |
{Client « Expédié par »} |
votre numéro de client* |
{Client « Expédié au nom de »} |
le numéro de client « Expédié au nom de » ou indiquez de nouveau votre numéro de client |
*Si vous n'êtes pas un client commercial de Postes Canada titulaire d'une convention, mais que vous mettez en place une solution d'expédition par tierce partie destinée aux clients commerciaux, veuillez lire les renseignements importants sur la façon de mettre à l'essai les services d'expédition avec convention dans notre environnement « Bac à sable ».
En-têtes HTTP
Variable des en-têtes HTTP |
Valeur |
---|---|
Accept |
application/vnd.cpc.shipment-v8+xml (Remarque : */* à la place de la valeur de l’en-tête affichera un message d’erreur) |
Content-Type |
application/vnd.cpc.shipment-v8+xml (Remarque : */* à la place de la valeur de l’en-tête affichera un message d’erreur) |
Authorization |
Basic {Encodage 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"?
>
<shipment xmlns=”http://www.canadapost.ca/ws/shipment-v8”>
xxx
</shipment>
Éléments de la demande
La présente section décrit les éléments XML d'entrée pour ce service. Pour obtenir la structure hiérarchique, consultez le diagramme XML.
Créer l'envoi – Éléments de la demande | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Nom de l'élément | Type | Requis/Optionnel | Description | ||||||||||||||||||||||||||||||||||
shipment |
complexe |
requis |
Élément XML de niveau supérieur de la structure de la réponse. |
||||||||||||||||||||||||||||||||||
create-qr-code |
simple |
optionnel |
Il s'agit d'un élément facultatif, utilisé pour demander l'image de code QR de l'étiquette publique au format base64, ainsi que contient l'URL de l'étiquette de clé publique et la date d'expiration. Si c'est vrai, deux nouveaux liens sont fournis : publicLabel et publicKeyInfo. Remarque : Applicable uniquement à 8 1/2 X 11 papier codé en pdf |
||||||||||||||||||||||||||||||||||
create-public-key |
simple |
optionnel |
Il s'agit d’un élément facultatif, utilisé pour demander l'URL de l'étiquette de clé publique et la date d'expiration. Si c'est vrai, deux nouveaux liens sont fournis : publicLabel et publicKeyInfo Remarque : Applicable uniquement à 8 1/2 X 11 papier codé en pdf |
||||||||||||||||||||||||||||||||||
customer-request-id |
simple |
optionnel |
(Chaîne de caractères – Jusqu’à 35 caractères) 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é. Vous pouvez également utiliser ce numéro d’identification pour récupérer les détails relatifs à l’envoi, tels que l’étiquette, sans avoir à fournir d’information dans la réponse « Créer l’envoi ». Au lieu de cela, il suffit d’utiliser ce numéro d’identification dans les demandes Obtenir l’envoi. |
||||||||||||||||||||||||||||||||||
group-id |
simple |
requis sous condition |
(Chaîne de caractères – Jusqu'à 32 caractères) Cet élément correspond au numéro d'identification du groupe (ou au nom du groupe) dans lequel il faut placer l'envoi créé. Le groupe sera créé par le service de Postes Canada s'il n'existe pas. Doit être précédé par le numéro de la version de l’espace de nommage que vous utilisez, par exemple, <v8:group-id>1234</v8:group-id> L'élément group-id est requis, à moins que l'élément transmit-shipment soit fourni; dans un tel cas, l'élément group-id ne doit par être fourni. Il ne faut pas créer un groupe unique pour chaque envoi individuel. Un group-id a pour but de regrouper plusieurs envois ensemble afin de les inclure sur le même manifeste. Par exemple, le regroupement est utile dans les scénarios suivants :
Remarque : Les envois du régime intérieur, à destination des États-Unis et du régime international seront placés sur des manifestes séparés, même s'ils contiennent le même group-id. Limites du rendement
Limites du système
|
||||||||||||||||||||||||||||||||||
transmit-shipment |
simple |
requis sous condition |
{true} Fait partie de shipment. Doit être précédé par le numéro de la version de l’espace de nommage que vous utilisez, par exemple, <v8:transmit-shipment>true</v8:transmit-shipment> Cet élément désigne un envoi pour lequel un manifeste n'est pas requis à titre de preuve de paiement. Cet envoi sera transmis immédiatement et une demande de service « Transmettre les envois » n'est pas requise. Utilisez cet élément si vous expédiez moins de 50 colis par jour à partir de différents endroits à l'aide de l'un des modèles opérationnels ci-dessous.
Lorsque cet élément est réglé à « Vrai », la facturation sera effectuée immédiatement après la présentation d'une demande de création d'un envoi. Votre envoi ne peut pas être annulé. Important : Si vous utilisez les procédés traditionnels liés à l'expédition avec convention et aux manifestes (p. ex. si vous expédiez plus de 50 colis par jour à partir d'un entrepôt central), ce procédé ne vous convient pas. Vous devez continuer à utiliser le procédé habituel lié aux manifestes. Le non-respect de cette consigne entraînera le refus de votre envoi jusqu'à ce que vous produisiez les manifestes requis. Si vous êtes un client des services d’expédition sans convention qui utilise des services Web d’expédition avec convention, vous devez fournir cet élément. |
||||||||||||||||||||||||||||||||||
quickship-label-requested |
simple |
optionnel |
{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. Réglez cet élément à « true » et, à des fins de facturation, fournissez le code du pays (doit être CA) et le code postal dans la structure de destination. Une étiquette comprenant un code à barres de repérage et la mention « Quick Ship – Refer to Address Label/Expédition rapide – Reportez-vous à l’étiquette d’adresse » sera créée. Fournissez uniquement ce paramètre lorsque vous souhaitez créer une étiquette d'expédition rapide (ne fournissez pas ce paramètre lorsque l'élément est réglé à « false »). |
||||||||||||||||||||||||||||||||||
requested-shipping-point |
simple |
requis sous condition |
(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 où vos envois sont ramassés. Le code postal fourni est utilisé aux fins de tarification. Si vous déposez vous-même vos envois, vous avez deux choix :
Nota : L'utilisation de l'élément requested-shipping-point pour indiquer le code postal de votre lieu d'expédition ne sera plus possible dans une version future. Si vous déposez vous-même vos envois, nous vous recommandons d'utiliser l'élément shipping-point-id. Cet élément est obligatoire lorsque l'indicateur de ramassage de la SCP (cpc-pickup-indicator) est fourni. Option s'excluant mutuellement avec l'élément shipping-point-id; cependant, l'une des deux doit être saisie. |
||||||||||||||||||||||||||||||||||
cpc-pickup-indicator |
simple |
Optionnel |
(true) Réglez cet élément à « true » si vos envois sont ramassés par Postes Canada ou par une tierce partie. Fournissez le code postal de votre lieu de ramassage dans l'élément requested-shipping-point. Ne fournissez pas ce renseignement si vous déposez vous-même vos envois. Option s'excluant mutuellement avec l'élément shipping-point-id. Vous devez aussi régler cet élément à « true » dans votre demande Transmettre les envois. 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) ou déposé à un emplacement de Postes Canada (en fournissant l'élément shipping-point-id). Nous vous recommandons de vous préparer à ce changement en offrant cet indicateur (et l'élément requested-shipping-point) si votre envoi est ramassé par Postes Canada. |
||||||||||||||||||||||||||||||||||
shipping-point-id |
simple |
Requis sous condition |
(Chaîne de quatre caractères alphanumériques) Si vous déposez vos articles à un bureau de poste ou à une autre installation de Postes Canada, fournissez le numéro d'emplacement de ce lieu de dépôt. Recherchez le numéro d'emplacement en question à l'aide de la fonction Trouver un lieu de dépôt. Cette information est utilisée pour la tarification. Vous devrez aussi fournir de nouveau le numéro d'identification du lieu d'expédition (requested-shipping-point) dans votre demande de service Transmettre les envois. Si vous n'entrez pas le même numéro d'emplacement, des ajustements tarifaires peuvent s'imposer. Option s'excluant mutuellement avec l'option requested-shipping-point; cependant, l'une des deux doit être saisie. Nota : Si vous déposez vous-même vos envois, nous vous recommandons d'utiliser cet élément plutôt que l'élément requested-shipping-point pour indiquer votre lieu d'expédition. |
||||||||||||||||||||||||||||||||||
expected-mailing-date |
simple |
optionnel |
(Format de la date : AAAA-MM-JJ) Nota : Vous pouvez omettre cet élément. Il sera utilisé dans une version future. Le tarif de tous les envois est établi en fonction de la date d'expédition actuelle, puis il est rajusté au moment de la transmission (si l'envoi est transmis à une date ultérieure). |
||||||||||||||||||||||||||||||||||
provide-pricing-info |
simple |
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 »). |
||||||||||||||||||||||||||||||||||
provide-receipt-info |
simple |
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 »). |
||||||||||||||||||||||||||||||||||
delivery-spec |
complexe |
requis |
Fournit une description des détails de la demande de livraison, y compris le destinataire, le code de service, l'expéditeur, les options, les spécifications de l'envoi, les renseignements liés à l'avis et les numéros d'identification de référence. |
||||||||||||||||||||||||||||||||||
service-code |
simple |
requis |
(Chaîne de caractères – Jusqu'à 32 caractères) Doit être un code valide correspondant au service de livraison de Postes Canada utilisé pour expédier l'article. Les codes les plus fréquemment utilisés sont énumérés ci-dessous.
(Nota : Les services de livraison et leurs codes peuvent être obtenus en faisant appel aux services « Obtenir les tarifs » et « Découvrir les services » décrits dans la section Tarification.) |
||||||||||||||||||||||||||||||||||
sender |
complexe |
requis |
Cette structure contient des données sur l'expéditeur correspondant à l'adresse de l'expéditeur figurant sur l'étiquette. Les champs vides seront retirés pendant le 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'à 44 caractères) Nom de l'expéditeur 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. |
||||||||||||||||||||||||||||||||||
contact-phone |
simple |
requis |
(Chaîne de caractères – Jusqu'à 25 caractères) Numéro de téléphone de l'expéditeur avec qui il faut communiquer. |
||||||||||||||||||||||||||||||||||
address-details |
complexe |
requis |
Contient les données d'adressage de l'expéditeur. Les champs d'adresse vides seront retirés pendant le formatage des étiquettes. 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) Adresse 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'à 20 caractères) Province de l'expéditeur. Utilisez les codes standards des provinces canadiennes. |
||||||||||||||||||||||||||||||||||
country-code |
simple |
requis |
(Code de pays valide à deux caractères) Code de pays de l'expéditeur. Doit être CA. |
||||||||||||||||||||||||||||||||||
postal-zip-code |
simple |
requis |
(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 ».
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. Si l'option « Livrer au bureau de poste » est sélectionnée, l'élément « name » doit être précisé pour la destination. N'est pas requis lorsque quickship-label-requested est réglé à « true ». 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. Ces renseignements sont imprimés directement au-dessus de la ligne d'adresse 1 sur l'étiquette d'expédition. |
||||||||||||||||||||||||||||||||||
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, sauf si l'option « Livrer au bureau de poste » a été sélectionnée. Remarque : En plus des chiffres, les caractères suivants sont acceptés dans ce champ :
|
||||||||||||||||||||||||||||||||||
address-details |
complexe |
requis |
Contient les données d'adressage liées à la destination de l'envoi. Les champs vides seront retirés pendant le formatage des étiquettes. |
||||||||||||||||||||||||||||||||||
address-line-1 |
simple |
requis sous condition |
(Chaîne de caractères – Jusqu'à 44 caractères) Adresse de l'expéditeur. N'est pas requis lorsque quickship-label-requested est réglé à « true »; obligatoire sinon. |
||||||||||||||||||||||||||||||||||
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 sous condition |
(Chaîne de caractères – Jusqu'à 40 caractères) Ville de destination. Optionnel pour les envois du régime international. Requis pour les envois à destination des États-Unis et du régime intérieur. N'est pas requis lorsque quickship-label-requested est réglé à « true ». |
||||||||||||||||||||||||||||||||||
prov-state |
simple |
requis sous condition |
(Chaîne de caractères – Jusqu'à 20 caractères) Province ou État de l'expéditeur. Il faut utiliser l'un des codes suivants :
Optionnel pour les envois du régime international. Requis pour les envois à destination des États-Unis et du régime intérieur. (Sauf lorsque quickship-label-requested est réglé à « true ».) |
||||||||||||||||||||||||||||||||||
country-code |
simple |
requis |
(Code de pays valide à deux caractères) Doit être CA lorsque l'élément quickship-label-requested est réglé à « true ». |
||||||||||||||||||||||||||||||||||
postal-zip-code |
simple |
requis sous condition |
Peut être l'un des éléments suivants :
Requis pour les pays nécessitant un code postal ou un code ZIP (p. ex. Canada, Code postal ou code ZIP de l'expéditeur. |
||||||||||||||||||||||||||||||||||
options |
complexe |
optionnel |
Contient les options liées au code du service de livraison (p. ex. couverture, CR). |
||||||||||||||||||||||||||||||||||
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 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 » :
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 |
||||||||||||||||||||||||||||||||||
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. Exemple : Pour l'option « COV », il s'agit du montant de la couverture à acheter. Pour l'option « COD », il s'agit du montant de base pour les envois contre remboursement (les frais d'expédition peuvent aussi être ajoutés par le système, tel qu'il est décrit ci-dessous pour l'élément « option-qualifier-1 »). Ne pas fournir 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 |
optionnel |
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 :
À 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 :
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. À l'heure actuelle, les options nécessitant un deuxième qualificatif sont les suivants : Livrer au bureau de poste |
||||||||||||||||||||||||||||||||||
parcel-characteristics |
complexe |
requis |
Décrit les caractéristiques du colis. |
||||||||||||||||||||||||||||||||||
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 |
optionnel |
Contient les dimensions physiques du colis qui peuvent être utilisées pour déterminer les frais d'expédition de façon plus précise. |
||||||||||||||||||||||||||||||||||
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. S'il est précisé, un prix plus exact peut être défini. |
||||||||||||||||||||||||||||||||||
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. S'il est précisé, 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. S'il est précisé, un prix plus exact peut être défini. |
||||||||||||||||||||||||||||||||||
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). |
||||||||||||||||||||||||||||||||||
oversized |
simple |
optionnel |
{vrai, faux} Indique si le colis est surdimensionné ou non. Nota : Si les dimensions du colis ont été fournies, cet élément sera donc automatiquement défini (comme étant vrai ou faux) en fonction de ces dimensions (peu importe si vous ajoutez une valeur dans le champ de l'élément « oversized »). Toutefois, si aucune dimension n'est fournie, vous pouvez préciser que le colis est surdimensionné (ou non) à l'aide de cet élément. |
||||||||||||||||||||||||||||||||||
notification |
complexe |
requis sous condition |
Contient 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. |
||||||||||||||||||||||||||||||||||
simple |
requis sous condition |
(Chaîne de caractères – Jusqu'à 60 caractères) Il doit s'agir d'une adresse électronique valide. Le format est (['_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 |
{vrai, faux} Cet élément est obligatoire si l'élément notification existe. Indique si vous souhaitez recevoir un avis électronique concernant l'expédition d'un envoi. |
||||||||||||||||||||||||||||||||||
on-exception |
simple |
requis sous condition |
{vrai, faux} Cet élément est obligatoire si l'élément notification existe. Indique si vous souhaitez recevoir un avis électronique concernant l'expédition d'un envoi. |
||||||||||||||||||||||||||||||||||
on-delivery |
simple |
requis sous condition |
{vrai, faux} Cet élément est obligatoire si l'élément notification existe. Indique si vous souhaitez recevoir un avis électronique concernant l'expédition d'un envoi. |
||||||||||||||||||||||||||||||||||
print-preferences |
complexe |
optionnel |
Contient les préférences d'impression pour les étiquettes. |
||||||||||||||||||||||||||||||||||
output-format |
simple |
optionnel |
{8.5x11, 4x6} Le format du papier ordinaire est de 8 ½ po sur 11 po alors que celui du papier thermosensible est de 4 po sur 6 po. |
||||||||||||||||||||||||||||||||||
Encoding | simple | optionnel | {PDF, ZPL} Servez-vous de ce champ pour préciser le format de sortie pour votre étiquette 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 » inclura un fichier contenant des commandes d'impression ZPL II. Vous devrez ensuite coder une solution ou utiliser une application afin d'envoyer les commandes directement à une imprimante thermique. Pour les étiquettes de format ZPL II, votre imprimante doit permettre la troncature. Utilisez notre exemple de code pour tester la capacité de votre imprimante à tronquer du texte. Le format ZPL est uniquement disponible sur du papier thermosensible, alors l'élément <output-format> doit être de 4 po sur 6 po. |
||||||||||||||||||||||||||||||||||
preferences |
complexe |
requis |
Contient un certain nombre de préférences en ce qui a trait à l'impression des étiquettes, etc. |
||||||||||||||||||||||||||||||||||
show-packing-instructions |
simple |
requis |
{vrai, faux} Indique si les directives d'emballage doivent être inscrites sur l'étiquette. |
||||||||||||||||||||||||||||||||||
show-postage-rate |
simple |
requis sous condition |
{vrai, faux} Indique si le tarif postal doit être inscrit sur l'étiquette. Cet élément est seulement requis pour les envois à destination des États-Unis et du régime international. |
||||||||||||||||||||||||||||||||||
show-insured-value |
simple |
requis sous condition |
{vrai, faux} Indique si la valeur assurée doit être inscrite sur l'étiquette. Cet élément est seulement requis pour les envois assurés à destination des États-Unis et du régime international. |
||||||||||||||||||||||||||||||||||
references |
complexe |
optionnel |
Contient des champs de référence que vous pouvez attribuer. Vous pouvez attribuer ces autres numéros d'identification (pouvant être uniques) à 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 que vous pouvez attribuer 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 |
Contient 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) Il s’agit de la devise du pays de destination. Le code de devise est converti en majuscules, s’il ne l’est pas déjà. La valeur doit être :
Requis si l'élément XML parent correspondant « customs » existe. |
||||||||||||||||||||||||||||||||||
conversion-from-cad |
simple |
requis sous condition |
(Champ numérique de trois chiffres, suivis de trois décimales [p. ex., format 999.999]) 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. Requis si l'élément XML parent correspondant « customs » existe et si la devise n'est pas canadienne. |
||||||||||||||||||||||||||||||||||
reason-for-export |
simple |
requis sous condition |
(Trois caractères) Code représentant la raison de l'exportation, lequel facilite le passage transfrontalier. Voici les codes et leurs significations : DOC = Document Requis si l'élément XML parent correspondant « customs » existe. |
||||||||||||||||||||||||||||||||||
other-reason |
simple |
requis sous condition |
(Chaîne de caractères – Minimum de 4 caractères; maximum de 44 caractères) Requis si l'élément « reason-for-export » 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 |
S'il existe un élément parent douanier correspondant, cet élément est obligatoire. 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 du manifeste pour faciliter le traitement du colis aux douanes. |
||||||||||||||||||||||||||||||||||
item |
complexe |
requis |
Il doit y avoir au moins une occurrence pour l'envoi. Il y a une limite de 500 éléments pour une « sku-list ». Contient les renseignements sur le type d'article (nombre d'unités, valeur par unité, etc.) que comprend l'envoi. |
||||||||||||||||||||||||||||||||||
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.
|
||||||||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||||||
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 6 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. |
||||||||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||||||
unit-weight |
simple |
requis sous condition |
(Champ numérique de deux chiffres, suivis de trois décimales [p. ex. format 99.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. |
||||||||||||||||||||||||||||||||||
country-of-origin |
simple |
optionnel |
(Code de pays valide à deux caractères) Pays d'origine de l'article correspondant. Il faut indiquer ce code 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) Requis si le pays d'origine est le Canada. Province d'origine des biens. |
||||||||||||||||||||||||||||||||||
settlement-info |
complexe |
requis |
Cette structure comprend les détails sur le client pour le règlement des paiements, y compris le mode de paiement, le client et le client « Expédié au nom de ». |
||||||||||||||||||||||||||||||||||
paid-by-customer |
simple |
optionnel |
(10 caractères numériques) Les numéros de client « Expédié par » comptent 10 chiffres. Si le numéro fourni est inférieur à 10 chiffres, le système ajoutera des zéros au début jusqu'à ce qu'il y ait 10 chiffres. Il s'agit du numéro du client qui recevra la facture pour l'envoi. Il correspond habituellement au même numéro de client « Expédié au nom de », à moins qu'une relation de payer central n'ait été signalée à Postes Canada. S'il n'est pas fourni, le numéro de client « Expédié au nom de » s'affiche par défaut. |
||||||||||||||||||||||||||||||||||
contract-id |
simple |
requis sous condition |
(10 caractères numériques) Les numéros d'identification de convention comptent 10 chiffres. Si le numéro fourni est inférieur à 10 chiffres, le système ajoutera des zéros au début jusqu'à ce qu'il y ait 10 chiffres. Requis pour déterminer les rabais consentis par convention si le mode de paiement voulu est « Compte ». |
||||||||||||||||||||||||||||||||||
cif-shipment | Simple | optionnel |
{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 »). |
||||||||||||||||||||||||||||||||||
intended-method-of-payment |
simple |
requis |
Chaîne de caractères – Jusqu'à 15 caractères Cet élément indique le mode de paiement du client pour un article n’exigeant pas de manifeste (« transmit-shipments=true »), ou lorsque la méthode de paiement voulue est différente (le mode de paiement est indiqué dans la demande de service « Transmettre les envois » subséquente). Les valeurs valides pour le mode de paiement voulu sont les suivantes :
|
||||||||||||||||||||||||||||||||||
promo-code |
simple |
optionnel |
Chaîne de caractères – Jusqu’à 10 caractères. Code de réduction promotionnelle. Veuillez noter que les codes promotionnels sont uniquement valides pour une certaine période et pour certains produits. Votre bulletin de participation sera converti en majuscules (p. ex., vous pouvez utiliser des lettres minuscules ou un mélange de minuscules et de majuscules et obtenir le même résultat). 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 :
|
||||||||||||||||||||||||||||||||||
return-spec |
complexe |
optionnel |
Contient les détails liés à la demande de livraison d'un envoi retourné, y compris le destinataire de l'envoi retourné, le nombre d'étiquettes, le code du service et les numéros d'identification de référence. Si cet élément est absent, aucune étiquette d'expédition du Service de retour n'est requise. |
||||||||||||||||||||||||||||||||||
service-code |
simple |
requis |
(Chaîne de caractères – Jusqu'à 32 caractères) Doit être un code valide correspondant au service de livraison de Postes Canada utilisé pour expédier l'article. Les codes les plus fréquemment utilisés sont énumérés ci-dessous.
(Nota : Les services de livraison et leurs codes peuvent être obtenus en faisant appel aux services « Obtenir les tarifs » et « Découvrir les services » décrits dans la section Tarification.) |
||||||||||||||||||||||||||||||||||
return-recipient |
complexe |
requis sous condition |
Requis si l'élément XML parent correspondant « return-spec » existe. La structure de l'élément « return-recipient » fournit les détails d'expédition (p. ex. adresse) pour la livraison d'un envoi retourné, tels qu'ils figurent sur l'étiquette du Service de retour. |
||||||||||||||||||||||||||||||||||
name |
simple |
optionnel |
(Chaîne de caractères – Jusqu'à 44 caractères) Nom du destinataire de l'envoi retourné avec qui il faut communiquer. |
||||||||||||||||||||||||||||||||||
company |
simple |
optionnel |
(Chaîne de caractères – Jusqu'à 44 caractères) Nom de l'entreprise du destinataire de l'envoi retourné. |
||||||||||||||||||||||||||||||||||
address-details |
complexe |
requis sous condition |
Requis si l'élément parent « return- recipient » existe (si vous avez précisé que vous avez besoin d'une adresse de retour). Contient les données d'adressage du destinataire de l'envoi retourné. Les champs vides seront retirés des champs relatifs à l'adresse aux fins de formatage des étiquettes. |
||||||||||||||||||||||||||||||||||
address-line-1 |
simple |
requis |
(Chaîne de caractères – Jusqu'à 44 caractères) Ligne d'adresse 1 du destinataire de l'envoi retourné. |
||||||||||||||||||||||||||||||||||
address-line-2 |
simple |
optionnel |
(Chaîne de caractères – Jusqu'à 44 caractères) Ligne d'adresse 2 du destinataire de l'envoi retourné. |
||||||||||||||||||||||||||||||||||
city |
simple |
requis |
(Chaîne de caractères – Jusqu'à 40 caractères) Ville du destinataire de l'envoi retourné. |
||||||||||||||||||||||||||||||||||
prov-state |
simple |
requis |
(Chaîne de caractères – Jusqu'à 20 caractères) Province pour le paiement CR. Code de province standard pour les provinces au Canada. |
||||||||||||||||||||||||||||||||||
postal-zip-code |
simple |
requis sous condition |
Code postal canadien comptant six caractères alphanumériques pour l'adresse du destinataire de l'envoi retourné. (A9A9A9) |
||||||||||||||||||||||||||||||||||
return-notification |
simple |
optionnel |
(Chaîne de caractères – Jusqu'à 60 caractères) Le format est (['_A-Za-z0-9\-\+]+)(\.['_A-Za-z0-9\-\+]+)*@([A-Za-z0-9-]+)(\.[A-Za-z0-9-]+)*(\.[A-Za-z]{2,5}). Il s'agit de l'adresse électronique à laquelle un avis de livraison sera envoyé lorsque les envois retournés seront livrés. |
||||||||||||||||||||||||||||||||||
pre-authorized-payment |
complexe |
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. |
||||||||||||||||||||||||||||||||||
account-number |
simple |
requis |
(Chaîne de caractères – Jusqu’à 16 caractères) Le numéro de compte à partir duquel le montant sera retiré; sera utilisé aux fins de rapprochement. |
||||||||||||||||||||||||||||||||||
auth-code |
simple |
requis |
(Chaîne de caractères – Jusqu’à 16 caractères) Le code d’autorisation du fournisseur; sera utilisé aux fins de rapprochement. |
||||||||||||||||||||||||||||||||||
auth-timestamp |
simple |
requis |
La date et l’heure d’autorisation; seront utilisés aux fins de rapprochement. |
||||||||||||||||||||||||||||||||||
charge-amount |
simple |
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). |
Demande – Diagramme XML
Voici la structure hiérarchique des éléments XML devant être utilisée pour les données d'entrée afin de créer un envoi.
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 – Aperçu détaillé des éléments de réponse | ||
---|---|---|
Nom de l'élément | Type | Description |
shipment-info | Complex | Niveau supérieur de la structure XML |
customer-request-id | Simple | Votre code de transaction unique, si vous l’avez indiqué dans votre demande. |
tracking-pin | Simple | (Numérique – Jusqu'à 16 chiffres) Fait partie des shipment-info. 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 en ligne pour les colis, notamment le service Obtenir les détails de suivi. |
return-tracking-pin | Simple | (Numérique – Jusqu'à 16 chiffres) Fait partie des shipment-info. Il s'agit du numéro d'identification du produit (NIP) pour l'envoi de retour. Le NIP de repérage peut être utilisé en tant que donnée d'entrée pour toute autre demande de service en ligne pour les colis, notamment le service Obtenir les détails de suivi. |
shipment-id | Simple | (Chaîne alphanumérique – Jusqu'à 32 lettres/chiffres) Fait partie des shipment-info. 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. |
shipment-status | Simple | (Chaîne de caractères – Jusqu'à 14 caractères) Les valeurs valides sont les suivantes :
Fait partie des shipment-info. Indique l'état actuel de l'envoi. |
po-number |
Simple |
Il s'agit du numéro de bon de commande de Postes Canada. Il ne s'applique et n'est affiché que pour pour lequel un manifeste n'est pas requis à titre de preuve de paiement. |
shipment-price | Complexe | 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. |
shipment-receipt | Complexe | 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). |
links | Complex | Fait partie des shipment-info. Cette structure représente une liste de liens vers les renseignements concernant l'envoi créé. |
link | Complex | Fait partie des links. 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 pas de sous-éléments.) La structure des liens comprend un certain nombre d'éléments de lien. Ces éléments permettent à l'utilisateur de récupérer séparément les différents résultats du service Créer l'envoi 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.
Cela indique que le lien représente l'étiquette Service de retour produite dans le cadre du procédé de création d'un envoi. Dans ce cas, l'attribut « href » correspond au point final du service Obtenir l'artefact pour cette étiquette. (Consultez la section Obtenir l'artefact pour obtenir des renseignements sur la façon de faire.) L'attribut media-type désignera le format du fichier graphique (PDF ou ZPL). |
Réponse – Diagramme XML
Le diagramme suivant présente la structure XML de la réponse pour le service Créer l'envoi.
Réponse – Réponses d'erreur possibles
Dans le cas d'une erreur d'application, le corps du message XML aura une structure du message d'erreur plutôt qu'une réponse de réussite, mais le code HTTP sera 200. Voici des réponses d'erreur possibles :
Code | Description |
---|---|
1156 |
La ligne d’adresse 1 est un champ obligatoire. |
1157 |
La ville est obligatoire lorsqu'un envoi est expédié à destination du Canada ou des États-Unis. |
1159 |
La province est obligatoire pour une expédition au Canada et l'État est obligatoire pour une expédition aux É.-U. |
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.) |
1702 |
Le numéro de la convention n'est pas associé au numéro posté au nom du client dans le système comptable de la SCP pour la date d'envoi. |
1711 |
Veuillez sélectionner un autre mode de paiement. Le paiement peut uniquement être effectué par carte de crédit ou à partir d'un compte. |
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. |
7230 |
L'option Livrer au bureau de poste n'est pas autorisée avec le mode Expédition rapide, puisqu'elle nécessite le nom complet et l'adresse complète du destinataire. |
7282 |
Au moins un nom de destinataire ou un nom d'entreprise est requis conformément aux règlements douaniers. |
7285 | Étant donné que vous devez fournir un manifeste lorsque vous déposez des envois d'acheminement continu de marchandises d'arrivée (ACMA), vous ne pouvez pas régler l'élément transmit-shipment à « vrai » pour ces envois. |
7289 | Le service sélectionné n'est pas valide pour le client ou le contrat indiqué. |
7311 | Le montant préautorisé ne correspond pas aux frais calculés. |
7312 | Aucun compte de fournisseur par défaut n’est indiqué dans votre profil de Postes Canada. |
7313 | Le paiement par compte de fournisseur peut uniquement être soumis par le fournisseur du compte ou un utilisateur autorisé. |
7314 | Le code de la demande existe déjà; il doit être unique lorsqu’il est fourni. |
7315 | L’élément « customer-request-id » est obligatoire dans le cas d’un paiement préautorisé. |
7316 | Le paiement préautorisé est uniquement valide lorsque l’élément « transmit-shipment=true » et que le mode de paiement est « SupplierAccount ». |
7317 | L’émetteur du compte de fournisseur par défaut dans votre profil de Postes Canada en ligne ne correspond pas à la plateforme que vous utilisez. |
7322 | Le code de devise n’est pas un code de devise ISO à trois caractères valide (comme USD). |
9186 |
Seulement un numéro d'identification d'expédition (shipping-point-id) ou requested-shipping-point peut être fourni. |
9187 |
L'élément requested-shipping-point est obligatoire lorsque l'indicateur de ramassage de la SCP (cpc-pickup-indicator) est fourni. |
9188 |
L'élément shipping-point-id n'est pas valide. |
9189 |
Les éléments requested-shipping-point et shipping-point-id s'excluent mutuellement. |
9191 | Le langage ZPL est utilisé pour les imprimantes thermiques. Vous pouvez donc l'utiliser uniquement avec du papier thermosensible de 4 po sur 6 po. |
Consultez la liste exhaustive de messages d'erreur et de stratégies d'atténuation.
Consultez les autres codes de statut HTTP.
Exemples
Exemple de demande REST – Créer l'envoi
<shipment xmlns="http://www.canadapost.ca/ws/shipment-v8">
<group-id>grp1</group-id>
<requested-shipping-point>K2B8J6</requested-shipping-point>
<cpc-pickup-indicator>true</cpc-pickup-indicator>
<delivery-spec>
<service-code>DOM.EP</service-code>
<sender>
<name>Bob</name>
<company>CGI</company>
<contact-phone>1 (450) 823-8432</contact-phone>
<address-details>
<address-line-1>502 MAIN ST N</address-line-1>
<city>MONTREAL</city>
<prov-state>QC</prov-state>
<country-code>CA</country-code>
<postal-zip-code>H2B1A0</postal-zip-code>
</address-details>
</sender>
<destination>
<name>Jain</name>
<company>CGI</company>
<address-details>
<address-line-1>23 jardin private</address-line-1>
<city>Ottawa</city>
<prov-state>ON</prov-state>
<country-code>CA</country-code>
<postal-zip-code>K1K4T3</postal-zip-code>
</address-details>
</destination>
<options>
<option>
<option-code>DC</option-code>
</option>
</options>
<parcel-characteristics>
<weight>20</weight>
<dimensions>
<length>6</length>
<width>12</width>
<height>9</height>
</dimensions>
<mailing-tube>false</mailing-tube>
</parcel-characteristics>
<notification>
<email>john.doe@yahoo.com</email>
<on-shipment>true</on-shipment>
<on-exception>false</on-exception>
<on-delivery>true</on-delivery>
</notification>
<print-preferences>
<output-format>8.5x11</output-format>
</print-preferences>
<preferences>
<show-packing-instructions>true</show-packing-instructions>
<show-postage-rate>false</show-postage-rate>
<show-insured-value>true</show-insured-value>
</preferences>
<settlement-info>
<contract-id>0040662505</contract-id>
<intended-method-of-payment>Account</intended-method-of-payment>
</settlement-info>
</delivery-spec>
</shipment>
Nota : Le lien vers le point final HTTP et la Content-value ne doivent pas être figés dans le code. Ces valeurs doivent plutôt être fournies à titre de données de sortie pour les services Créer l'envoi et Obtenir l'envoi.
Exemple de réponse XML – Créer l'envoi
<shipment-info>
<shipment-id>347881315405043891</shipment-id>
<shipment-status>created</shipment-status>
<tracking-pin>12345</tracking-pin>
<links>
<link rel="self" href="https://XX/rs/111111111/2222222222/shipment/347881315405043891" media-type="application/vnd.cpc.shipment-v8+xml"></link>
<link rel="details" href="https://XX/rs/111111111/2222222222/shipment/347881315405043891/details" media-type="application/vnd.cpc.shipment-v8+xml"></link>
<link rel="group" href="https://XX/rs/111111111/2222222222/shipment?groupid=bobo" media-type="application/vnd.cpc.shipment-v8+xml"></link>
<link rel="price" href="https://XX/rs/111111111/2222222222/shipment/347881315405043891/price" media-type="application/vnd.cpc.shipment-v8+xml"></link>
<link rel="label" href="https://XX/rs/artifact/11111111/5555555/0" media-type="application/pdf" index="0"></link>
</links>
</shipment-info>