Les données d'entrée comprennent :

• le numéro du client « Expédié au nom de »;
• la liste de groupes prêts pour le ramassage ou le dépôt;
• le lieu de ramassage ou de dépôt pour vos envois;
• le mode de paiement;
• la liste facultative d'envois devant être exclus du ramassage.

Une série de numéros d'identification de manifestes constitue les données de sortie. Vous devez utiliser ces numéros pour présenter une demande de service « Obtenir le manifeste » pour créer un manifeste avec succès.

Notes de mise à jour

transmit-shipments-request

complexe

requis

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

mailed-by

simple

requis

(1 à 10 caractères numériques)

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

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

mobo

simple

optionnel

(1 à 10 caractères numériques)

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

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

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

locale

simple

optionnel

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

EN = Anglais
FR = Français

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

transmit-set

complexe

requis

Structure ou élément XML contenant les données d'entrée pour un envoi.

customer-request-id

Simple

Optionnel

Pour utilisation future.

group-ids

complexe

requis

Il s'agit d'une liste de numéros d'identification de groupe. Le service Transmettre les envois créera un manifeste pour chaque groupe. Le manifeste comprendra la liste des envois compris dans le groupe (à l'exception des envois que vous excluez).

group-id

simple

requis

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

Occurrence (1 à N fois).

Il s'agit du numéro d'identification de groupe dont les envois doivent être inclus dans le procédé de transmission.

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 :

• Vous avez plusieurs emplacements de service.
• Vous souhaitez que tous les envois dans un groupe soient expédiés le même jour.
• Vous voulez regrouper les envois ensemble aux fins de référence interne ou de facturation.

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
Afin d'éviter un délai de temporisation de nos serveurs, veuillez suivre ces recommandations :

• Ne pas inclure plus de 30 groupes par manifeste (p. ex. un maximum de 30 group-ids dans une seule demande de service Transmettre les envois).
• Ne pas placer plus de 5 000 envois dans un groupe.

Limites du système
Pour éviter une erreur, veuillez ne pas dépasser les limites suivantes avant d'effectuer une demande de service Transmettre les envois :

• Maximum de 50 groupes par manifeste (erreur 9109 si la limite est dépassée).
• Maximum de 10 000 envois dans un groupe (erreur 9110 si la limite est dépassée).
• Maximum de 10 000 envois dans l'ensemble de plusieurs groupes (erreur 9108 si la limite est dépassée).

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

Si vous déposez vous-même vos envois, vous avez deux choix :

• ne pas régler cet élément, et indiquer le numéro d'identification de l'emplacement d'expédition dans shipping-point-id (option recommandée);
• fournir le code postal de votre lieu d'expédition ici et ne pas régler l'élément shipping-point-id.

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.

Si vous fournissez ici le même code postal que vous avez utilisé dans vos demandes de service « Créer l'envoi », aucun rajustement tarifaire ne sera associé au point de départ pour l'expédition. Si vous utilisez ici un code postal différent de celui utilisé dans les demandes de service « Créer l'envoi », un rajustement tarifaire pourrait être effectué selon la distance entre le point d'expédition initial (dans la demande de service « Créer l'envoi ») et le point d'expédition final (dans la demande de service « Transmettre les envois »).

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. Ne fournissez pas cet élément si l'élément est réglé à « false ». Fournissez le code postal de votre lieu de ramassage dans l'élément requested-shipping-point. Si vous utilisez le même indicateur et le même point d'expédition demandé (requested-shipping-point) que ceux utilisés dans la demande de service « Créer l'envoi », il n'y aura aucun rajustement tarifaire; consultez les détails 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.

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.

Si vous saisissez un numéro d'emplacement différent de celui fourni dans votre demande de service « Créer l'envoi », 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.

detailed-manifests

simple

requis

{vrai, faux}

Cela indique si une version résumée ou très détaillée du manifeste sera produite.

method-of-payment

simple

requis

{Chaîne de 15 caractères}

Cela désigne le mode de paiement utilisé pour les manifestes devant être générés.

Les modes de paiement valides sont les suivants :

• Account = Le paiement se fera par l'entremise d'une convention en vigueur qui aura été conclue avec le payeur.
• CreditCard = Le paiement sera effectué par carte de crédit.
• SupplierAccount = le paiement se fera par l’intermédiaire du compte de fournisseur désigné comme valeur par défaut dans le profil du client (offert uniquement aux fournisseurs de comptes de fournisseur).

Nota : Différents payeurs pourraient être associés à différents envois. Des manifestes distincts seront générés pour les envois dont les payeurs sont différents.

manifest-address

complexe

requis

Cette structure contient l'adresse imprimée sur l'étiquette du manifeste.

manifest-name

simple

optionnel

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

Nom de la personne-ressource figurant dans l'adresse du manifeste.

Le nom est imprimé sur le manifeste.

phone-number

simple

requis

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

Numéro de téléphone devant être imprimé sur le manifeste.

address-details

complexe

requis

Cette structure contient les détails de l'adresse pour l'adresse du manifeste. L'adresse est imprimée sur le manifeste.

address-line-1

simple

requis

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

Ligne d'adresse 1 pour l'adresse du manifeste.

address-line-2

simple

optionnel

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

Ligne d'adresse 2 pour l'adresse du manifeste.

city

simple

requis

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

Ville pour l'adresse du manifeste.

prov-state

simple

requis

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

Province (ou État) pour l'adresse du manifeste.

country-code

simple

requis sous condition

(deux caractères)

Code de pays pour l’adresse du manifeste; CA et US sont acceptés.

Obligatoire si US. Facultatif si CA.

postal-zip-code

simple

requis

Code postal (ou ZIP) pour l'adresse du manifeste. Peut être l'un des éléments suivants :

1. (Six caractères alphanumériques pour le Canada [A9A9A9]) –
   Format [A-Z]\d[A-Z]\d[A-Z]\d

2. (Code numérique à cinq chiffres ou à neuf chiffres [cinq chiffres suivis de quatre autres chiffres] pour les États-Unis) –
   Format \d{5}(-\d{4})?

customer-reference

simple

optionnel

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

Numéro de référence du client fourni, puis inscrit sur le manifeste et affiché dans une demande de service « Obtenir les détails du manifeste ».

excluded-shipments

complexe

optionnel

Il s'agit de la liste de numéros d'identification pour les envois devant être exclus de la transmission. Ces envois demeureront dans leur groupe et ils seront automatiquement ramassés au cours de la prochaine transmission.

shipment-id

simple

optionnel

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

Il s'agit d'un numéro d'identification représentant un envoi existant qui doit être exclu du service « Transmettre les envois ».

Nota : Il faut récupérer le numéro d'identification de l'envoi fourni dans le cadre des demandes de service précédentes « Créer l'envoi » et « Obtenir l'envoi ». Les données de sortie de ces services comprendront un numéro d'identification pour l'envoi.

manifest-company

simple

requis

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

Nom de l'entreprise figurant dans l'adresse du manifeste.

Elle est imprimée sur le manifeste.

transmit-shipments-response

Complexe

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

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

manifests

Complexe

Structure XML contenant les résultats liés à l'exécution réussie du service en question.

manifest-id

Simple

Occurrence (0 à N fois).

Numéro d'identification du manifeste. Il s'agit d'un numéro unique dans le domaine du client « Expédié au nom de » qui est utilisé pour toutes les autres demandes de service (« Obtenir le manifeste », « Obtenir les détails du manifeste », « Obtenir les envois ») lorsqu'un numéro d'identification unique est requis pour le manifeste.

Si vous tentez de transmettre des envois que nous avons facturés automatiquement (dans les cas où vous avez déposé des envois avant d’effectuer une demande de service Transmettre les envois), vous recevrez un lien vers un manifeste vide. Le manifeste vide vous informe que vos envois ont été facturés automatiquement et fournit des détails sur la façon d’éviter que cela ne se reproduise.

Le manifeste vide ne contient pas les envois ou les détails et ne peut pas être récupéré au moyen du paramètre Obtenir les manifestes ni utilisé pour déposer du courrier. Le manifeste détaillé que nous avons créé pour vous au moyen des envois qui vous ont été facturés automatiquement sera envoyé à l’adresse courriel qui figure dans votre profil de Postes Canada en ligne.

7313

Le paiement par compte de fournisseur peut uniquement être soumis par le fournisseur du compte.

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.

9118

ID du groupe : La valeur « 99 » est introuvable pour la transmission. Veuillez la supprimer ou la corriger.

9119

ID de l'envoi : La valeur « 12373264234 » est introuvable pour l'exclusion. Veuillez la supprimer ou la corriger.

9122

Tous les groupes de la demande de transmission étaient vides ou tous les envois étaient exclus. Il n'y avait rien à transmettre.

9186

Seulement un numéro d'identification d'expédition (shipping-point-id) ou un indicateur de ramassage de la SCP (cpc-pickup-indicator) 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.