Ramassage

Créer une demande de ramassage – Module REST

Résumé

Nom : Créer une demande de ramassage
Raison pour utiliser le service : Pour créer une demande pour un ramassage sur demande ponctuel.
Données d'entrée : Détails du ramassage
Données de sortie : ID de la demande de ramassage et liens
Demande de service précédente habituelle : Obtenir la disponibilité du service de ramassage
Prochaine demande de service habituelle : Obtenir les détails sur la demande de ramassage
Historique des versions :

Notes de mise à jour

Créer une demande de ramassage – Résumé du service

Créer une demande de ramassage – Résumé du service

Détails sur la demande

Demande – Structure pour le service « Créer une demande de ramassage »

Point final

POST https://XX/enab/{customer}/pickuprequest

Remplacez... Par...

XX (Conception)

ct.soa-gw.postescanada.ca

XX (Production)

soa-gw.canadapost.ca

{customer}

Votre numéro de client

En-têtes HTTP

Variable des en-têtes HTTP

Valeur

Accept

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

Content-Type

application/vnd.cpc.pickuprequest+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"?>
<pickup-request-details xmlns="http://www.canadapost.ca/ws/pickuprequest”>
xxx
</pickup-request-details>

Demande – Éléments

Le tableau ci-dessous décrit les éléments XML d'entrée pour le service « Créer une demande de ramassage ». Pour obtenir la structure hiérarchique des entrées, consultez le diagramme XML.

Créer une demande de ramassage – Éléments de la demande
Nom de l'élément Type Requis/Facultatif Description

pickup-request-details

Complexe

Requis

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

pickup-type

Simple

Requis

Type de demande de ramassage:

  • Ondemand – ramassage sur demande (ponctuel)

pickup-location

Complexe

Requis

Structure contenant l'adresse du lieu de ramassage.

business-address-flag

Simple

Requis sous condition

{true}
La valeur « vrai » signifie que le ramassage est à effectuer à l'adresse commerciale précisée dans votre profil Postes Canada. (Afin de vérifier l'adresse que nous avons pour vous dans nos dossiers, vous pouvez ouvrir une session dans votre profil.)
Ne doit pas être proposée si l’element « alternate-address » est fourni.

alternate-address

Complexe

Requis sous condition

Adresse pour un ramassage en tierce partie.
Requise pour ramassages en tierce partie. Ne doit pas être proposée si l'indicateur « business-address-flag » est vrai.
Les ramassages sur demande à une adresse différente ne peuvent être payés que par carte de crédit.

company

Simple

Requis

(Chaîne de caractères – Jusqu'à 35caractères)
Raison sociale de l'organisation qui demande le ramassage.
Requise pour ramassages en tierce partie.(Indicateur d'adresse commerciale = faux). Ne doit pas être proposée si l'indicateur d'adresse commerciale = vrai.

address-line-1

Simple

Requis

(Chaîne de caractères – Jusqu'à 35caractères)
Adresse municipale du lieu de ramassage.
Requise pour ramassages en tierce partie.(Indicateur d'adresse commerciale = faux). Ne doit pas être proposée si l'indicateur d'adresse commerciale = vrai.

city

Simple

Requis

(Chaîne de caractères – Jusqu'à 35caractères)
Ville du lieu de ramassage.
Requise pour ramassages en tierce partie.(Indicateur d'adresse commerciale = faux). Ne doit pas être proposée si l'indicateur d'adresse commerciale = vrai.

province

Simple

Requis

(2caractères)
Province du lieu de ramassage.
Code de province standard à 2caractères pour les provinces au Canada.
Requise pour ramassages en tierce partie.(Indicateur d'adresse commerciale = faux). Ne doit pas être proposée si l'indicateur d'adresse commerciale = vrai.

postal-code

Simple

Requis

(6caractères alphanumériques)
Code postal du lieu de ramassage au format «A9A9A9».
Requise pour ramassages en tierce partie.(Indicateur d'adresse commerciale = faux). Ne doit pas être proposée si l'indicateur d'adresse commerciale = vrai.

contact-info

Complexe

Requis

Structure contenant la personne-ressource à qui adresser les questions ou les demandes.

contact-name

Simple

Requis

(Chaîne de caractères – Jusqu'à 45caractères)
Nom de la personne-ressource désignée pour le ramassage.

email

Simple

Requis

(Chaîne de caractères – Jusqu'à 60caractères)
Il doit s'agir d'une adresse électronique valide.
Le format est le suivant: (['_A-Za-z0-9\-\+]+)(\.['_A-Za-z0-9\-\+]+)*@([A-Za-z0-9\-]+)(\.[A-Za-z0-9\-]+)*(\.[A-Za-z]{2,5}).
Adresse électronique à laquelle envoyer les mises à jour de l'état de votre demande de ramassage.

contact-phone

Simple

Requis

(Chaîne de caractères – Jusqu'à 16caractères numériques)
Numéro de téléphone de la personne-ressource désignée pour le ramassage.
Format 999-999-9999

telephone-ext

Simple

Facultatif

(Jusqu'à 6caractères numériques)
Numéro du poste téléphonique.

receive-email-updates-flag

Simple

Facultatif

{vrai, faux}
La valeur «vrai» indique que vous voulez recevoir de mises à jour de l'état de votre demande.
La valeur par défaut est «faux».

location-details

Complexe

Requis

Structure contenant les caractéristiques du lieu physique où le ramassage doit avoir lieu.

five-ton-flag

Simple

Facultatif

{vrai, faux}
La valeur «vrai» indique qu'un camion de cinq tonnes est requis.
S'applique seulement aux demandes de ramassage sur demande.
La valeur par défaut est «faux».

loading-dock-flag

Simple

Facultatif

{vrai, faux}
La valeur «vrai» indique qu'il y a un quai de chargement au lieu de ramassage.
La valeur par défaut est «faux».

pickup-instructions

Simple

Requis

(Chaîne de caractères de jusqu’à 132 caractères, coupure après 40)
Instructions à l'intention du conducteur (p.ex. utiliser la porte arrière ou la porte latérale, apporter une plate-forme à roues).

items-characteristics

Complexe

Facultatif

Structure contenant les détails relatifs aux types d'articles à ramasser.
Structure pour déterminer qu'un traitement spécial est nécessaire pour les articles à ramasser.
Applicable uniquement aux ramassages sur demande.

pww-flag

Simple

Facultatif

{vrai, faux}
Indique si des articles PrioritéMondial peuvent être disponibles pour le ramassage.
La valeur par défaut est «faux».

priority-flag

Simple

Facultatif

{vrai, faux}
Indique si des articles prioritaires peuvent être disponibles pour le ramassage.
La valeur par défaut est «faux».

returns-flag

Simple

Facultatif

{vrai, faux}
Indique si des articles renvoyés peuvent être disponibles pour le ramassage.
La valeur par défaut est «faux».

heavy-item-flag

Simple

Facultatif

{vrai, faux}
Indique si certains articles à ramasser peuvent peser plus de 23kg (50lb).
La valeur par défaut est «faux».

pickup-volume

Simple

Requis

(Chaîne de caractères – Jusqu'à 40caractères)
Nombre prévu d'articles à ramasser. Vous pouvez ajouter d’autres renseignements, comme « 50 colis et 10 paquets ».

pickup-times

Complexe

Requis

Structure contenant la date et la période à laquelle le ramassage doit avoir lieu.

on-demand-pickup-time

Complexe

Requis sous condition

Structure contenant les détails d'une demande de ramassage sur demande.
À remplir uniquement pour une demande de ramassage sur demande.

date

Simple

Requis

(Format de la date: AAAA-MM-JJ)
Date à laquelle vous souhaitez votre ramassage sur demande. La date doit se situer dans les cinq jours suivants, à moins que vous ne disposiez d'une convention du service de colis, auquel cas la limite peut être reportée à 30 jours.

 preferred-time

Simple

Requis

(Format de l'heure: HH:MM)
Heure préférée du ramassage sur demande. Ramassage sur demande doit être entre 12h00 (midi) et 16h00, à intervalles de 15 minutes (soit 0h00, 0h15, 0h30 ou 0h45).

closing-time

Simple

Requis

(Format de l'heure: HH:MM)
Heure limite pour le ramassage sur demande. Ramassage sur demande doit être entre 12h00 (midi) et 16h00, à intervalles de 15 minutes (soit 0h00, 0h15, 0h30 ou 0h45).

scheduled-pickup-times

Option non utilisée. Demandez un ramassage à horaire fixe à l’aide de notre outil en ligne.

payment-info

Complexe

Facultatif

Structure contenant les détails du paiement.

contract-id

Simple

Facultatif

(Jusqu'à 10caractères numériques)
Votre numéro de convention du service de colis, s'il y a lieu.

method-of-payment

Simple

Facultatif

Dans la version initiale, le système déterminera le mode de paiement :

  • Si vous ne disposez pas d'une convention du service de colis, des frais seront imputés sur la carte de crédit par défaut enregistrée dans votre profil en ligne (ou la demande sera rejetée si vous ne disposez pas d'une carte de crédit par défaut dans votre dossier).
  • Si vous disposez d'une convention du service de colis et que vous demandez un ramassage à votre adresse principale (sur demande), celui-ci sera facturé à votre compte (à moins que ce dernier ne soit bloqué, auquel cas, la carte de crédit par défaut enregistrée dans votre profil en ligne sera utilisée; ou bien la demande sera rejetée si vous ne disposez pas d'une carte de crédit par défaut dans votre dossier).
  • Si vous disposez d’une convention du service de colis avec option de ramassage par un tiers activée, ou disposez de l’autorité d’utiliser une telle convention, et que vous demandez un ramassage à une adresse différente, celui-ci sera facturé à votre compte (si votre compte est bloqué, il sera facturé à la carte de crédit par défaut enregistrée dans votre profil en ligne; si vous n’avez pas de carte de crédit par défaut, votre demande sera rejetée).

Demande – Diagramme XML

Créer une demande de ramassage – Structure de la demande XML
Créer une demande de ramassage – Structure de la demande XML

Détails de la réponse

Réponse – Éléments

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

Créer une demande de ramassage – Éléments de la réponse
Nom de l'élément Type Description

pickup-request-info

Complexe

Il s'agit de l'élémentXML de niveau supérieur de la réponse contenant les détails sur la demande de ramassage.

pickup-request-header

Complexe

Renseignements de base sur la demande.

request-id

Simple

Numéro d'identification de la demande de ramassage.

request-status

Simple

Statut de la demande.
Une demande de ramassage créée avec succès aura toujours le statut «Active». Consultez la réponse de la service Obtenir les détails sur la demande de ramassage pour d'autres statuts possibles après la création.

 pickup-type

Simple

Type de ramassage demandé: OnDemand (sur demande).

request-date

Simple

Date à laquelle la demande de ramassage a été créée.

pickup-request-price

Complexe

Renseignements seulement fournis pour les demandes de ramassage sur demande.

pre-tax-amount

Simple

Tarif de base du ramassage.

gst-amount

Simple

Montant de la taxe sur les produits et services.

pst-amount

Simple

Montant de la taxe de vente provinciale.

hst-amount

Simple

Montant de la taxe de vente harmonisée.

due-amount

Simple

Total des frais.

cc-receipt-details

Complexe

Structure contenant les détails requis pour un reçu de carte de crédit. Ces détails sont seulement fournis pour une demande de ramassage sur demande payée par carte de crédit.

merchant-name

Simple

La valeur sera la suivante: "CanadaPost".

merchant-url

Simple

La valeur sera la suivante: "www.canadapost.ca".

name-on-card

Simple

Nom figurant sur la carte de crédit par défaut sauvegardée par PostesCanada, s'il y a lieu.

auth-code

Simple

Code d'autorisation reçu de la société émettrice de la carte de crédit.

auth-timestamp

Simple

Date et heure auxquelles la transaction a été autorisée par la société émettrice de cartes de crédit.

card-type

Simple

Type de carte de crédit utilisé pour l'achat.

charge-amount

Simple

Montant autorisé par la société émettrice de la carte de crédit.

currency

Simple

Devise de la transaction: CAD.

transaction-type

Simple

La valeur sera la suivante: "Sale".

links

Complexe

Structure contenant les liens vers les renseignements sur la demande de ramassage.

link

Complexe

Utilisez ces liens pour récupérer les divers résultats du service «Créer une demande de ramassage» et avoir recours à diverses fonctions supplémentaires pour la demande de ramassage. Chaque lien représente un lien vers l'un des services en ligne.
Occurrence (1 à Nfois).
(Remarque: L'élément du lien est «Complexe», car il contient de nombreux attributs. Il ne comprend aucun sous-élément.)
Les liens ci-dessous s'afficheront avec un type de «rel» unique:

  1. rel="self"

Ce lien représente la demande de ramassage qui vient d'être créée. L'attribut «href» peut être utilisé comme point final du service «Mettre à jour la demande de ramassage».

  1. rel = "details"

Ce lien représente les détails supplémentaires de la demande de ramassage et il n'est pas généré dans la réponse du service «Créer une demande de ramassage». L'attribut «href» est un point final du service «Récupérer les demandes de ramassage» servant à récupérer ces renseignements supplémentaires.

Réponse – Diagramme XML

Créer une demande de ramassage – Structure de la réponse XML
Créer une demande de ramassage – Structure de la réponse XML

Réponses d'erreur possibles

Une demande bien structurée peut recevoir l'une des réponses d'erreur d'application suivantes :

Code Description

11000

Ladresse est incomplète (manque le numéro dunité, par exemple).

11001

Le numéro de convention est invalide ou nexiste pas. Vous devez utiliser une convention pour colis.

11002

Il y a déjà une demande de ramassage en dedans dune heure de celle-ci.

11003

Le ramassage ne peut être effectué à la date requise (elle est dans le passé, invalide ou nest pas un jour ouvrable).

11005

Le numéro de client est invalide. Veuillez corriger ou contacter Postes Canada pour plus de détails.

11009

Le ramassage nest pas disponible au code postal spécifié.

11010

Vous devez avoir une carte de crédit en filière lorsque vous utilisez cette méthode de paiement.

11015

Lheure de ramassage préférée na pas été fournie. Veuillez corriger votre demande.

11016

Votre heure de fermeture ne peut être avant votre heure de ramassage préférée.

11018

Lapprobation de paiement a été refusée  Veuillez essayer plus tard ou communiquer avec la Gestion des comptes de Postes Canada au 1-800-267-7651.

11020

La transaction a été refusée. Veuillez vérifier votre carte de crédit.

11021

Le ramassage ne peut être effectué à lheure spécifiée car elle est en dehors des heures de ramassage de {0} à {1}.

11111

Erreur de système. Veuillez essayer plus tard ou contactez la ligne dassistance de la SCP.

Voir aussi 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 une demande de ramassage

<pickup-request-details>
  <pickup-type>OnDemand</pickup-type>
  <pickup-location>
    <business-address-flag>false</business-address-flag>
    <alternate-address>
      <company>Jim Duggan</company>
      <address-line-1>2271 Herring Cove</address-line-1>
      <city>Halifax</city><province>NS</province>
      <postal-code>B3L2C2</postal-code>
    </alternate-address>
  </pickup-location>
  <contact-info>
    <contact-name>John Doe</contact-name>
    <email>john.doe@canadapost.ca</email>
    <contact-phone>800-555-1212</contact-phone>
    <opt-out-email-updates-flag>true</opt-out-email-updates-flag>
    <receive-email-updates-flag>true</ receive-email-updates-flag>
  </contact-info>
  <location-details>
    <five-ton-flag>false</five-ton-flag>
    <loading-dock-flag>true</loading-dock-flag>
    <pickup-instructions>Door at Back</pickup-instructions>
  </location-details>
  <items-characteristics>
    <pww-flag>true</pww-flag>
    <priority-flag>false</priority-flag>
    <returns-flag>true</returns-flag>
    <heavy-item-flag>true</heavy-item-flag>
  </items-characteristics>
  <pickup-volume>50</pickup-volume>
  <pickup-times>
    <on-demand-pickup-time>
      <date>2015-01-28</date>
      <preferred-time>15:00</preferred-time>
      <closing-time>17:00</closing-time>
    </on-demand-pickup-time>
  </pickup-times>
</pickup-request-details>

Exemple de réponse XML selon le module REST – Créer une demande de ramassage

<pickup-request-info>
<pickup-request-header>
<request-id>1212121212</request-id>
<request-status>pending</request-status>
<request-date>20140909</request-date>
</pickup-request-header>
<links>
<link rel="self" href="https://ct.soa-gw.canadapost.ca/enab/1234567/pickuprequest/1212121212" media-type="application/vnd.cpc.pickuprequest+xml"></link>
<link rel="details" href="https://ct.soa-gw.canadapost.ca/enab/1234567/pickuprequest/1212121212/details" media-type="application/vnd.cpc.pickuprequest+xml"></link>
</links>
</pickup-request-info>

Environnement « Bac à sable » (développement) pour la réponse XML – Créer une demande de ramassage

La réponse est figée (statique) dans l'environnement de développement; par conséquent, vous recevrez toujours la même réponse peu importe les données dans votre demande. Veuillez noter que les valeurs pour l'élément <request-id> sont les suivants:

  • ramassage sur demande : 0074698052

Pour tester une erreur d'arrière-plan (c.-à-d les validations du schéma sont toutes effectuées dans l'environnement du développement) dans la structure du lieu de ramassage indiquée dans l'élément code postal comme A9A9A9; l'erreur 11000 s'affichera. Aucun autre message d'erreur ne sera affiché dans l'environnement du développement; par exemple, l'existence ou la validité de votre numéro de contrat ne sera pas vérifiée.