web service so livraison

Transcription

WEB SERVICE
SO LIVRAISON
1 – CHOIX DE LIVRAISON
Solution FLEXIBILITE - Spécifications techniques
Version 3.4 - Avril 2013
62 RUE CAMILLE DESMOULINS – 92441 ISSY LES MOULINEAUX CEDEX 15 – www.colissimo.fr/entreprises
RCS PARIS B 356 000 000 - Siret 356 000 000 00048 - NAF 5310 Z
Suivi des
Révision
3.2
3.3
Changements
Date
18/04/2011
04/06/2012
3.4
Web Service SO Livraison
Version 3.4 – Avril 2013
08/04/2013
Commentaires
• Version publiée
Information
sur
l’intégration
de
points
de
retrait
supplémentaires, autorisant des poids et dimensions de colis
allant jusqu’à 30kg et 200cm en développé.
• Précision sur les types de points de retrait et sur le
champ poids maxi, paragraphes §II.4.1.2.2 et
§II.4.2.2.2
Modification importante : montée de version du Webservice
en V2.0 suite à l’ouverture de l’offre à la Belgique.
• Nouvelle URL d’accès au Web Service (cf. I.5.2)
• Ajout de nouveaux paramètres pour gérer la
récupération de points de retrait à l’international (cf.
§II.4.1.1, §II.4.2.1, §II.5.1.1, §II.5.2.1)
• Ajout de nouveaux types de points (cf. §I.2.1)
• Identification des points de retrait via le couple
« identifiant / code réseau » (cf. §II.4.1.2.2, §II.4.2.1,
§II.4.2.2.2, §II.5.2.1)
2
I.
INTRODUCTION .................................................................................................................................. 4
I.1
I.2
I.2.1
I.3
I.4
I.5
I.5.1
I.5.2
I.5.3
I.6
I.6.1
I.6.2
II.
OBJET DU DOCUMENT .................................................................................................................................... 4
FRONT OFFICE CLIENT : POINTS DE VIGILANCE ......................................................................................... 4
TYPES DE POINTS RETOURNES ................................................................................................................................. 6
TERMINOLOGIE ............................................................................................................................................... 7
INTRODUCTION A SOAP ................................................................................................................................. 8
SOAP COTE CLIENT ...................................................................................................................................... 9
IMPLEMENTATION CLIENT ...................................................................................................................................... 9
IMPLEMENTATION CLIENT DU WEB SERVICE SO LIVRAISON........................................................................................... 9
UTILISATION DU SERVICE ...................................................................................................................................... 10
GENERALITES RELATIVES AUX ECHANGES SUR INTERNET ........................................................................ 10
PRECONISATION DE COLIPOSTE POUR L’UTILISATION DE CE WEBSERVICE : ...................................................................... 10
RESPONSABILITE LIEE AUX ECHANGES INFORMATIQUES : ............................................................................................. 11
INTERFACES ....................................................................................................................................... 12
II.1 FONCTIONNALITES ....................................................................................................................................... 12
II.2 MODALITES D’ACCES AU WEB SERVICE SO LIVRAISON .......................................................................... 12
II.3 INDISPONIBILITE DU WEB SERVICE SO LIVRAISON ET CONTINUITE DU PROCESSUS DE COMMANDE .. 12
II.4 INTERFACE SOAP ........................................................................................................................................ 13
II.4.1
METHODE FINDRDVPOINTRETRAITACHEMINEMENT............................................................................................. 13
II.4.1.1 PARAMETRES EN ENTREE.................................................................................................................................. 13
II.4.1.2 REPONSE ...................................................................................................................................................... 16
II.4.1.2.1 STRUCTURE RDVPOINTRETRAITACHEMINEMENTRESULT .................................................................................... 16
II.4.1.2.2 STRUCTURE POINTRETRAITACHEMINEMENT .................................................................................................... 17
II.4.1.2.3 STRUCTURE CONGES ................................................................................................................................... 21
II.4.2
METHODE FINDPOINTRETRAITACHEMINEMENTBYID ............................................................................................ 23
II.4.2.1 PARAMETRES EN ENTREE.................................................................................................................................. 23
II.4.2.2 REPONSE ...................................................................................................................................................... 25
II.4.2.2.1 STRUCTURE POINTRETRAITACHEMINEMENTBYIDRESULT ................................................................................... 26
II.4.2.2.2 STRUCTURE POINTRETRAITACHEMINEMENT .................................................................................................... 26
II.4.2.2.3 STRUCTURE CONGES ................................................................................................................................... 30
II.5 INTERFACE HTTPS......................................................................................................................................... 32
II.5.1
METHODE FINDRDVPOINTRETRAITACHEMINEMENT............................................................................................. 32
II.5.1.1 PARAMETRES D’ENTREE HTTPS ........................................................................................................................ 32
II.5.1.2 REPONSE DE LA REQUETE ................................................................................................................................. 32
II.5.2
METHODE FINDPOINTRETRAITACHEMINEMENTBYID ............................................................................................ 34
II.5.2.1 PARAMETRES D’ENTREE HTTPS ........................................................................................................................ 34
II.5.2.2 REPONSE DE LA REQUETE ................................................................................................................................. 35
III.
IV.
CODES ERREURS ........................................................................................................................... 37
CONTACT .............................................................................................................................................. 38
3
I.
Introduction
I.1 Objet du document
Dans le cadre de l’offre So Colissimo, ColiPoste met à disposition de ses clients ecommerçants un Web Service qui restitue les différents modes de livraison proposés pour les
destinataires de leurs colis :
•
•
•
•
•
•
Le Rendez-vous à domicile le soir entre 17h et 21h30
Les bureaux de Poste et autres points de retrait La Poste
Les consignes automatiques Cityssimo
Les commerces de proximité du réseau PICKUP, groupe La Poste
Les bureaux de Poste belges du groupe BPOST
Les commerces de proximité du réseau BPOST
Ce document décrit les généralités du protocole SOAP utilisé ainsi que les modalités d’accès
au Web Service So Livraison.
Abréviation
JRE
XML
XSL
XSLT
Description
Java TM Runtime Environment
eXtensible Markup Language
eXtensible Stylesheet Language
XSL Transformations
I.2 Front Office client : Points de vigilance
La mise en place de l’offre So Colissimo sur le Front Office d’un client chargeur, implique de
respecter un certain nombre de points de vigilance importants.
Ces points de vigilance permettent notamment de s’assurer :
-
-
d’éviter tout malentendu du client destinataire, sur la nature de la prestation de
transport (présentation appropriée de l’offre So Colissimo, récapitulatif du mode de
livraison choisi, …).
que cette étape en amont permet de récupérer les données indispensables au bon
déroulement de la prestation de transport (données de livraison exhaustives,
informations de contact du destinataire, …).
La Poste – Coliposte demande à ses clients chargeurs, en préalable du lancement effectif de
l’offre sur leur site de production, de bien vouloir l’associer à leur phase de validation de
4
cette partie de leur Front Office, en communiquant à leur interlocuteur commercial, un
compte de test.
Cas de test et points à vérifier
Demande du numéro de téléphone portable dans le process de commande
Numéro de téléphone portable
obligatoire
Format du numéro de téléphone
portable
A un moment ce numéro de téléphone portable doit être demandé au
destinataire
Pour les destinataires français, le numéro de téléphone portable doit
commencer par 06 ou 07 et être sur 10 chiffres, sans espace, "." ou
autre caractères.
Pour les destinataires belges, le numéro de téléphone portable doit
commencer par le caractère + suivi de 324, suivi de 8 chiffres
De même il est souhaitable d'interdire les :
- numéros de téléphone avec 8 chiffres identiques (0600000000,
0700000000, 0666666666, 0777777777...)
- 0612345678 ou 0712345678
Présentation de la livraison dans le tunnel d'achat
Présence de l'offre So Colissimo
RDV proposé à Paris seulement
Points de retrait internationaux
Présence de tous les types de points
de retrait
Noms des modalités de livraison
corrects
Description des offres correcte
Surcoût de la livraison sur RDV
Surcoût de la livraison en Belgique
Autorisé: 750XX avec XX de 01 à 20 + 75116; 69100 ne doit pas
proposer du RDV par exemple.
Si vous avez activé l’option internationale (cf. II.4.1.1), veuillez vous
assurer que votre site affiche bien les points de retrait belges
susceptibles d’être retournés par notre Web Service
La présentation des modes de livraison est faite conformément à nos
attentes.
- Ordre à respecter :
mon domicile
mon rendez-vous
mon espace cityssimo
mon bureau de poste (en France ou à l’étranger)
mon commerçant (en France ou à l’étranger)
+ Etre vigilant sur la présence des Cityssimo
Ne pas mettre de M majuscule à "mon".
Le nom de tous les modes de livraison s'écrit totalement en minuscule.
Les modalités de livraison sont bien décrites
S'assurer que le surcoût de la livraison sur RDV est intégré au coût de
livraison global
S'assurer que le surcoût éventuel de la livraison en Belgique est
intégré au coût de livraison global, en fonction de votre grille tarifaire.
Affichage des points hors domicile
Affichage des horaires
Possibilité de rechercher un point de
retrait situé ailleurs
Affichage des points accessibles aux
personnes en situation de handicap
Chaque type de point à son logo
correspondant
Les horaires sont consultables par les internautes
Il est possible de rechercher un point de retrait situé sur une autre zone
géographique
Il est possible d'identifier les points de retrait accessibles aux
personnes en situation de handicap (logo ou texte)
Chaque type de points est représenté par le bon logo (dans liste et/ou
carte)
•
pour les bureaux de poste (en France et à l’étranger)
5
•
pour les relais commerçants (en France et à l’étranger)
•
pour les consignes Cityssimo
Expérience destinataire
Explications sur l'expérience client en
termes de réception de la commande
Information sur les délais de livraison
Le site indique clairement comment la livraison va se dérouler (pour le
RDV et le hors domicile)
Les délais de livraison annoncés (et la date de livraison indicative)
doivent tenir compte du temps de préparation de la commande.
Sauf à ce que l’expédition des commandes se fasse le jour même, il ne
faut pas annoncer aux internautes une livraison en 48h
Récapitulatif de la commande
Sur le site
Email de confirmation
Pour chacun des modes de livraison, le récapitulatif de la commande
fait bien apparaître le mode de livraison.
L'adresse de livraison est la bonne
Pour chacun des modes de livraison, le récapitulatif de la commande
fait bien apparaître le mode de livraison.
L'adresse de livraison est la bonne
Page présentant la livraison sur le site (hors tunnel d'achat)
Présence de l'offre So Colissimo
Description correcte de l'offre So
Colissimo
Bon logo
La livraison via So Colissimo est présente
Si elle est présente, la description de l'offre doit être correcte
Le bon logo doit être utilisé, sans cohabitation avec le logo Colissimo
Suivi pour la France Métropolitaine
CGV
So Colissimo inclus dans CGV
Utilisation des données personnelles
Les CGV du chargeur indiquent que la livraison peut se faire via So
Colissimo
Le chargeur fait-il référence à la transmission des données
personnelles à un tiers ?
Carnet d'adresses
Pas d'enregistrement des points de
retrait hors domicile dans le carnet
d'adresses
Vérifier que les adresses des points de retrait hors domicile n'ont pas
été enregistrées dans le carnet d'adresse suite aux commandes
passées sur le site.
I.2.1 Types de points retournés
Différents types de points de retrait peuvent être retournés par la méthode
findRDVPointRetraitAcheminement. Le type d’un point se retrouve dans le trigramme
typeDePoint retourné dans la réponse de la méthode findRDVPointRetraitAcheminement
(cf. II.4.1.2 Réponse).
Le tableau ci-dessous récapitule les particularités de chaque type de point. Il est également
valable pour un appel du Web Service en HTTPS (cf. II.5 Interface https).
6
Mode de livraison
/ logo
« ma consigne
cityssimo »
« mon
de poste »
bureau
Trigramme
typeDePoint
Remarques
CIT
Cityssimo (France)
BPR
Bureaux de poste en
France
Agences ColiPoste
(France)
Centres de distribution
de La Poste (France)
Bureaux de poste en
Belgique
(étiquettes différentes)
Commerces de
proximité en France
Commerces de
proximité en Belgique
(étiquettes différentes)
ACP
CDI
BDP
« mon
commerçant »)
A2P
CMT
Limite de
poids/dimension
en développé1
20kg/150cm
20kg/150cm
30kg/200cm
30kg/200cm
30kg/150cm
10kg/150cm
10kg/150cm
Pour bénéficier de la tolérance offerte par les points de type « ACP », « CDI », et « BDP », il
convient donc :
- de ne pas mettre en place en amont de l’appel au webservice, de filtrage global audelà de 20 kg,
- de fournir le poids du colis dans le paramètre d’appel approprié (§II.4.1 : Weight).
- d’autoriser la sélection des points ACP et CDI pour les colis allant jusqu’à 200 cm en
développé, si votre Front-Office gère ce critère à cette étape du parcours client.
Les types de point ACP et CDI mettent tous à disposition des clients les services suivants :
- un parking dédié
- des outils de manutention pour faciliter le transport du/des colis jusqu’au véhicule
- une accessibilité aux personnes à mobilité réduite
Les logos et autres éléments graphiques (pictogrammes, bannières, …) associés à notre
solution et aux types de points remontés par le Web Service peuvent être téléchargés sur :
www.sobox.fr/charteweb (login : adminso, mot de passe : clp2010).
I.3 Terminologie
Terme
Point
de
retrait
Chargeur
Acheteur
Description
Lieu de livraison hors-domicile, dans lequel le colis est mis à disposition du
destinataire
E-marchand client de La Poste ColiPoste et invoquant le Web Service
Internaute, client du chargeur
1 Dimension en développé = longueur + largeur + hauteur
7
Ilot
Jour ouvré
Zone géographique représentant un bloc d’habitations, c'est-à-dire un espace
du territoire français délimité par des chaussées et qui répond à la
nomenclature définie par L’INSEE
Du lundi au vendredi hors jours fériés
I.4 Introduction à Soap
Un Web Service est un programme informatique permettant la communication et l'échange
de données entre applications et systèmes hétérogènes dans des environnements distribués,
sans intervention humaine et en temps réel.
Les Web Services exposent ces fonctionnalités sous la forme de services exécutables ou
procédures distantes (Remote Procedure Call). Leurs spécifications reposent sur un protocole
d’échanges standard : SOAP (Simple Object Access Protocol).
SOAP s'appuie sur un protocole de transport (HTTP, SMTP ou POP) et un langage structurant
les données échangées sous forme de messages : XML.
Exemple de requête et réponse HTTP, contenant des messages SOAP sous la forme de code
XML "enveloppé"
Source : W3C http://www.w3.org/TR/soap/
Exemple 1 : une requête HTTP contenant du code SOAP
POST /StockQuote HTTP/1.1
Host: www.stockquoteserver.com
Content-Type: text/xml; charset="utf-8"
Content-Length: nnnn
SOAPAction: "Some-URI"
<SOAP-ENV:Envelope
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<SOAP-ENV:Body>
<m:GetLastTradePrice xmlns:m="Some-URI">
<symbol>DIS</symbol>
</m:GetLastTradePrice>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Exemple 2 : la réponse HTTP correspondante
HTTP/1.1 200 OK
Content-Type: text/xml; charset="utf-8"
Content-Length: nnnn
8
<SOAP-ENV:Envelope
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/>
<SOAP-ENV:Body>
<m:GetLastTradePriceResponse xmlns:m="Some-URI">
<Price>34.5</Price>
</m:GetLastTradePriceResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
I.5 SOAP Côté Client
Il est préférable de disposer d’une « implémentation client » pour accéder à un Web Service
SOAP.
En voici une liste non exhaustive et qui concerne les langages les plus courants :
I.5.1 Implémentation Client
Langage
Java
.Net (C#, VB.Net,
ASP.Net)
Perl
C++
Implémentation client SOAP
Apache Axis : http://ws.apache.org/axis/index.html
Microsoft SOAP Toolkit : http://msdn.microsoft.com/webservices/
SOAP::Lite : http://www.soaplite.com/
Apache Axis C++ : http://ws.apache.org/axis/cpp
gSOAP C++ : http://www.cs.fsu.edu/~engelen/soap.html
PHP
SOAP C++ SQLData :
http://www.sqldata.com/soapclient/soapclient30.htm
PHP-SOAP : http://phpsoaptoolkit.sourceforge.net/phpsoap/
Python
PEAR SOAP Client/Server for PHP :
http://pear.php.net/package/SOAP
Python Web Services : http://pywebsvcs.sourceforge.net/
I.5.2 Implémentation Client du Web Service So Livraison
Le Web service So Livraison est accessible depuis l’adresse url suivante :
https://ws.colissimo.fr/pointretrait-ws-cxf/PointRetraitServiceWS/2.0?wsdl
Ce service nécessite l’utilisation de votre numéro de contrat ColiPoste et de votre mot de
passe, disponibles auprès de votre interlocuteur commercial La Poste ColiPoste habituel.
9
I.5.3 Utilisation du service
Ce service nécessite l’utilisation de votre numéro de contrat ColiPoste et de votre mot de
passe, disponibles auprès de votre interlocuteur commercial La Poste ColiPoste usuel.
Une fois ces informations récupérées, vous avez accès à votre espace client sous www.
Colissimo.fr/entreprises
Cet espace vous permet d’accéder via le lien Solution de livraison « Flexibilité » aux mises à
jour de cette documentation.
Attention :
Vous avez la possibilité via l’espace client de modifier votre mot de passe.
Si celui-ci est modifié, vous devez également le modifier dans l’invocation du
Web Service, faute de quoi l’accès au Web Service sera refusé.
I.6 Généralités relatives aux échanges sur Internet
HTTP, pour HyperText Transfer Protocol, est un protocole de communication client-serveur
développé pour le World Wide Web.
Lorsqu’elles sont transmises par le protocole HTTP, les données circulent sur internet, en
clair (sans être chiffrées).
Références complémentaires : http://fr.wikipedia.org/wiki/Hypertext_Transfer_Protocol
HTTPS, pour HyperText Transfer Protocol Secure — littéralement « protocole de transfert
hypertexte sécurisé » — est la combinaison du protocole HTTP avec une couche de
chiffrement comme SSL ou TLS.
Il garantit théoriquement la confidentialité et l'intégrité des données envoyées par
l'utilisateur et reçues du serveur.
Références complémentaires :
http://fr.wikipedia.org/wiki/HyperText_Transfer_Protocol_Secure
I.6.1 Préconisation de ColiPoste pour l’utilisation de ce webservice :
L’accès à ce web service étant protégé par un identifiant et un mot de passe, données à
caractère sensible, ColiPoste préconise d’utiliser le protocole HTTPS pour le transport de ces
données (cf. II.5 Interface https).
Ne pas utiliser ce protocole expose le Client à l’interception par un tiers malveillant, de ses
identifiants, ce qui permettrait à ce dernier d’usurper l’identité du Client, et ainsi :
• d’accéder à son espace entreprise (facture online, suivi des colis)
• de commander des produits, qui seront ensuite facturés au compte client usurpé
10
•
d’accéder aux autres solutions mises à disposition par ColiPoste
I.6.2 Responsabilité liée aux échanges informatiques :
Le Client s'engage à prendre toutes mesures propres à assurer la sécurité et la
confidentialité de son identifiant et de son mot de passe.
Tout accès et transmission de données effectuées et plus largement toute opération
effectuée en utilisant l’identifiant et le mot de passe du Client sont réputées effectués par ce
dernier.
11
II.
Interfaces
II.1 Fonctionnalités
Le Web Service décrit dans ce document expose :
•
•
la méthode findRDVPointRetraitAcheminement : à partir d’une adresse postale
fournie en entrée, indique si le mode de livraison Rendez-vous est éligible pour cette
adresse et restitue les points de retrait les plus proches de cette adresse.
la méthode findPointRetraitAcheminementByID : à partir d’un Identifiant de
point de retrait (code régate), restitue le détail des informations associé au point de
retrait transmis.
II.2 Modalités d’accès au Web Service SO Livraison
L’invocation du Web Service par le chargeur s’effectue via une requête HTTPS encapsulant
une demande de restitution de points de retrait.
Le service est accessible :
•
•
Soit via le protocole SOAP
Soit en appelant une URL HTTPS avec des paramètres d’entrée la syntaxe de l’URL est
présentée dans les paragraphes ci-dessous.
II.3 Indisponibilité du Web Service So Livraison et
continuité du processus de commande
En sus des mécanismes de supervision des infrastructures applicatives et matérielles qui ne
garantissent pas par eux-mêmes la disponibilité de l’ensemble de la chaine de traitement, la
Poste ColiPoste recommande aux chargeurs la mise en œuvre :
•
d’un contrôle préalable à l’invocation du Web Service
et/ou
•
de l’activation d’un mode dit « dégradé » en cas de non réponse, basé par exemple
sur la proposition d’un mode de livraison au domicile de l’internaute.
Pour ce faire, La Poste ColiPoste met à disposition des chargeurs, une URL de supervision
permettant de vérifier si le Web Service est disponible.
12
L’url de supervision fournie par La Poste ColiPoste est la suivante:
http://ws.colissimo.fr/supervision-wspudo/supervision.jsp
Cette page affiche [OK] si le WS est opérationnel.
Elle affiche [KO] dans le cas contraire.
La vérification de disponibilité du service consiste en l’appel de la page de supervision par le
chargeur suivi de la recherche de la chaîne de caractère [OK] dans cette page.
II.4 Interface SOAP
II.4.1 Méthode findRDVPointRetraitAcheminement
II.4.1.1 Paramètres en entrée
Paramètre
accountNumber
Signification
Type
Identifiant du client
6 caractères numériques
(NNNNNN)
password
Mot de passe
address
Numéro et libellé de la
voie de l’adresse de
livraison
Code
postal
de
l’adresse de livraison
Commune de l’adresse
de livraison
Pays de l’adresse de
livraison
Selon
la
norme ISO 3166
zipCode
city
countryCode
weight
Doit
être
cohérent
avec
l’option
international
(optionInter)
Poids du colis
shippingDate *
Date
estimée
de
Il s'agit du n° de client fourni
par La Poste ColiPoste sur 6
caractères. Numéro du client
remettant les colis, ce
numéro vous a été
communiqué à l'ouverture de
votre compte client.
Communiqué à l'ouverture de
200 caractères
alphanumériques
5 caractères
alphanumériques
50 caractères
alphanumériques
2 caractères
alphanumériques
Valeurs possibles : FR ou BE
Par défaut, vaut FR
Obligatoire
X
X
X
X
X
(NNNNNN)
Exprimé en grammes
10 caractères
X
13
l’envoi
filterRelay
Correspond à la date
de commande plus le
délai de préparation de
la commande en jours
ouvrés
Permet de filtrer les
points commerces de
proximité
alphanumériques
(JJ/MM/AAAA)
1 caractère alphanumérique
Valeurs possibles 0 ou 1
0 = le filtre est
appliqué, les points ne
sont pas proposés
requestId
lang
optionInter
1= le filtre n’est pas
appliqué, les points
sont proposés
Identifiant
unique
généré par l’utilisateur
du web service (par
exemple le numéro de
commande),
permettant d’identifier
la requête.
Langue de restitution
des noms et adresses
des points de retrait
Permet de filtrer ou
non les points situés à
l’étranger
Doit être cohérent
avec le code pays
(countryCode)
64 caractères
alphanumériques
2 caractères
alphanumériques
Valeurs possibles :
FR pour Français (valeur par
défaut)
NL pour Néerlandais**
1 caractère numérique
Valeurs possibles :
0 pour avoir des points en
France uniquement (valeur
par défaut)
1 pour des points en France
et à l’international
2 pour des points à
l’international uniquement
*Cas particulier de l’utilisation du WebService par les plateformes d’échanges entre
particuliers :
Dans ce cas précis, le processus de vente implique trois acteurs :
•
•
•
le chargeur (site Internet d’échanges),
un vendeur (client du chargeur),
un acheteur (lui aussi client du chargeur).
14
La « shipping date » correspond ici à la date prévisionnelle d’envoi du colis par le vendeur.
Elle permet d’identifier la disponibilité ou non d’un point de retrait hors domicile. Cette date
est fonction de la date de commande par l’acheteur, et tient compte de différents délais
relatifs à la transaction acheteur/vendeur : éventuel délai de confirmation de vente par le
vendeur, délai d’impression de l’étiquette, délai de dépôt du colis en bureau de Poste, etc.
**Attention : bien que le paramètre NL soit actuellement accepté, les informations des
points de retrait ne sont à ce jour pas mises à disposition en néerlandais. Le déploiement
complet du multilinguisme sera fait dans une version ultérieure.
15
Exemple d’enveloppe SOAP :
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v2="http://v2.pointretrait.geopost.com/">
<soapenv:Header/>
<soapenv:Body>
<v2:findRDVPointRetraitAcheminement>
<accountNumber>123456</accountNumber>
<password>ABC123</password>
<address>10, ROUTE DES VIGNES </address>
<zipCode>28500</zipCode>
<city> MORONVAL </city>
<countryCode>FR</countryCode>
<weight>150</weight>
<shippingDate>25/12/2009</shippingDate>
<filterRelay>1</filterRelay>
<requestId>1234567890ABCDEFGHIJ1234567890</requestId>
<lang>FR</lang>
<optionInter>1</optionInter>
</v2:findRDVPointRetraitAcheminement>
</soapenv:Body>
</soapenv:Envelope>
II.4.1.2 Réponse
C’est une structure SOAP du type rdvPointRetraitAcheminementResult.
II.4.1.2.1 Structure rdvPointRetraitAcheminementResult
Paramètre
Signification
Type
errorCode
errorMessage
Code de l’erreur
Libellé de l’erreur
xs:int
xs:string
listPointRetraitAc
heminement
Liste des points de
retrait
tns:pointRetrait
Acheminement
qualiteReponse
Indique la qualité de
la réponse obtenue
par rapport à
l'adresse de livraison
fournie dans la
requête pour la
restitution des points
de retrait
Plus les paramètres
d’entrée sont précis,
plus la qualité de la
recherche est grande.
xs:int
Commentaires
Voir paragraphe III Codes
erreurs
Voir paragraphe II.4.1.2.2
Structure
pointRetraitAcheminement
Valeurs possibles :
0 : mauvaise qualité, aucun
résultat
1 : qualité moyenne, La
recherche est basée sur
une reconnaissance à la
ville ou au code postal
2 : qualité excellente. La
recherche est basée sur
une reconnaissance à
l’adresse dans la ville
16
wsRequestId
rdv
Identifiant unique de
la requête généré par
le Web Service
Flag
indiquant
si
l’adresse de livraison
transmise est éligible
à la livraison sur
Rendez-vous
xs:string
64 caractères
alphanumériques
Boolean
Valeurs possibles :
« True » si l’adresse de
livraison passée en entrée
est éligible à la livraison sur
Rendez-vous
« False » si elle ne l’est
pas.
NB : si l’information n’est
pas disponible pour raisons
techniques, la valeur sera
positionnée à « False »
II.4.1.2.2 Structure pointRetraitAcheminement
Paramètre
Signification
accesPersonneMobil
iteReduite
Indique si le point
est accessible aux
personnes
à
mobilité réduite
adresse1
adresse2
adresse3
codePostal
Type
xs:boolean
Spécifique aux points de
retrait bureaux de poste
choisis (BPR).
Numéro et libellé
de la voie du point
Complément
d’adresse du point
Lieu-dit du point
xs:string
Code
point
xs:string
postal
du
Commentaires
Valeurs possibles : true pour
oui et false pour non
xs:string
xs:string
Peut-être affiché sous forme
de logo (disponible dans la
pictothèque So Colissimo –
voir à la fin de ce
paragraphe II.4.1.2.2 pour
vous le procurer) ou de
libellé. Peut également être
utilisé à des fins de filtre
lors de l’affichage sur le site
marchand.
Alphanumérique sur 38
caractères.
caractères.
caractères.
caractères.
Pour les clients transmettant
les annonces EDI : le code
postal doit être transmis
17
congesPartiel
congesTotal
Flag indiquant une
fermeture partielle
du point de retrait
sur le délai de
garde du colis
Flag indiquant une
fermeture
totale
du point de retrait
durant le délai de
garde du colis
xs:boolean
dans le rang 5 de
l’enregistrement de type
DDD001.
Permet d’identifier les points
de retrait ouverts au moins
7 jours ouvrés (du lundi au
vendredi) durant le délai de
garde du colis.
xs:boolean
Ces points de retrait doivent
être présentés et peuvent
être sélectionnés par
l’acheteur.
de retrait fermés durant la
période de retrait du colis.
Ces points doivent être
présentés mais le
chargeur doit empêcher
leur sélection par le
client.
coordGeolocalisatio
nLatitude
coordGeolocalisatio
nLongitude
distanceEnMetre
horairesOuvertureL
undi
Latitude du point
(norme
WGS84
métrique)
Longitude du point
(norme
WGS84
métrique)
Distance en
mètres par
rapport à l’adresse
fournie en entrée
xs:string
xs:string
xs:int
xs:string
Un traitement
différenciateur est
souhaitable (en grisé ou
information « en
congés »par exemple)
caractères
Ces coordonnées permettent
la localisation du point de
retrait sur un plan.
caractères
retrait de retrait sur un plan.
Numérique sur 5 caractères
caractères
18
Horaires
d’ouverture durant
la journée, au
format :
Une plage horaire non
renseignée équivaut à la
valeur « 00:00-00:00
00:00-00:00 », cette valeur
ne doit pas être affichée.
nn:nn-nn:nn
nn:nn-nn:nn
horairesOuvertureM
ardi
horairesOuvertureM
ercredi
horairesOuvertureJ
eudi
horairesOuvertureV
endredi
horairesOuvertureS
amedi
horairesOuvertureD
imanche
identifiant
Une plage horaire sans
coupure dans la journée a la
valeur 0 pour la plage de
l’après-midi (ex : 09:0017:30 00:00-00:00)
xs:string
xs:string
xs:string
xs:string
xs:string
xs:string
Identifiant du
point de retrait
xs:string
Cette identifiant doit être
importé dans votre solution
d’étiquetage.
Référence
La
Poste ColiPoste du
point (identifiant
unique).
indiceDeLocalisatio
n
Indice permettant
de
localiser
le
point.
Les informations « 00:0000:00 » ne doivent pas être
affichées
caractères
caractères
caractères
caractères
caractères
caractères
xs:string
les annonces EDI :
l’identifiant Regate doit être
transmis dans le rang 35 de
DDD001.
caractères
L’indice de localisation est
une donnée spécifique aux
points de retrait commerces
de proximité.
Exemple : Près de la gare
Il est fortement conseillé
d’afficher sur votre site
19
tns:conges
listeConges
localite
nom
périodeActiviteHora
ireDeb
ireFin
poidsMaxi
typeDePoint
codePays
langue
libellePays
Commune
du
point
Libellé du point
xs:string
Date de début de
la période durant
laquelle
s’appliquent les
horaires
Date de fin de la
période durant
laquelle
s’appliquent les
horaires
Poids
maximum
autorisé par colis
par le point
xs:string
Type de point
xs:string
caractères (JJ/MM)
xs:int
Exprimé en Kilogrammes
xs:string
Code
pays
du
point de retrait
Langue
libellés du
de retrait
xs:string
des
point
Libellé du pays du
point
marchand tous les champs
d’adresse ainsi que l’indice
de localisation du point de
retrait.
Structure Congés
caractères
caractères
caractères (JJ/MM)
xs:string
xs:string
xs:string
Important : Les points
de type ACP et CDI
acceptent les colis d’un
poids allant jusqu’à 30 kg
et 200 cm en développé2.
caractères
Valeurs possibles :
A2P, CIT, BPR, CDI, ACP,
BDP, ou CMT (voir détails en
I.2.1)
caractères
Valeurs possibles : FR (par
défaut) ou BE
caractères
défaut) ou NL
Est retourné en français ou
néerlandais en fonction de la
langue demandée en entrée
dans le champ lang
20
loanOfHandlingTool
parking
reseau
distributionSort
lotAcheminement
versionPlanTri
Indique si le point
dispose d’outils de
manutention
Indique si le point
dispose
d’un
parking
Identifiant
technique du
réseau auquel le
point appartient
Boolean
Données
d’acheminement
nécessaires pour
les clients utilisant
une solution
d’étiquetage
spécifique SO
LIBERTE.
xs:string
Si le point n’existe pas dans
la langue demandée, il ne
sera pas retourné
Boolean
xs:string
caractères
Vaut R12 pour les points
belges et R01 à R11 pour les
points français
caractères
Alphanumérique
sur
10
caractères
Alphanumérique
sur
2
caractères
xs:string
xs:string
Se reporter aux
documents
suivants:
2_LIBERTE_Cahier
des Charges Etiquettes So
Colissimo
2_LIBERTE_Spécif
ications
techniques EDI Annonces
Pour les clients
utilisant une
solution
d’étiquetage SO
SIMPLICITE ou SO
FLEXIBILITE (Inet,
WS d’étiquetage)
ces données
seront ignorées.
II.4.1.2.3 Structure Congés
21
Paramètre
Signification
début
Type
calendarDeDebut
Date de
congés
des
xs:dateTime
calendarDeFin
Date de fin des congés
xs:dateTime
numero
Numéro d’ordre de la
période de congés sur
une échelle de temps
xs:int
Commentaires
Date & Heure GMT au
format ISO-8601 (YYYYMMDDTHH:MM:SS.SSSZ)
Date & Heure GMT au
Numérique sur 1
caractère
Il peut y avoir de 0 à 3
périodes de congés par
point
Exemple d’enveloppe de retour :
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:findRDVPointRetraitAcheminementResponse xmlns:ns1="http://v2.pointretrait.geopost.com/">
<return>
<errorCode>0</errorCode>
<errorMessage>Code retour OK</errorMessage>
<listePointRetraitAcheminement>
<accesPersonneMobiliteReduite>false</accesPersonneMobiliteReduite>
<adresse1>PLACE DE L EGLISE</adresse1>
<adresse2/>
<adresse3/>
<codePostal>28500</codePostal>
<congesPartiel>false</congesPartiel>
<congesTotal>false</congesTotal>
<coordGeolocalisationLatitude>48.746887</coordGeolocalisationLatitude>
<coordGeolocalisationLongitude>1.419307</coordGeolocalisationLongitude>
<distanceEnMetre>1055</distanceEnMetre>
<horairesOuvertureDimanche>00:00-00:00 00:00-00:00</horairesOuvertureDimanche>
<horairesOuvertureJeudi>09:00-12:00 14:30-17:00</horairesOuvertureJeudi>
<horairesOuvertureLundi>09:00-12:00 14:30-17:00</horairesOuvertureLundi>
<horairesOuvertureMardi>09:00-12:00 14:30-17:00</horairesOuvertureMardi>
<horairesOuvertureMercredi>09:00-12:00 14:30-17:00</horairesOuvertureMercredi>
<horairesOuvertureSamedi>09:00-12:00 00:00-00:00</horairesOuvertureSamedi>
<horairesOuvertureVendredi>09:00-12:00 14:30-17:00</horairesOuvertureVendredi>
<identifiant>280980</identifiant>
<indiceDeLocalisation/>
<localite>CHERISY</localite>
<nom>BUREAU DE POSTE CHERISY BP</nom>
<periodeActiviteHoraireDeb>01/01</periodeActiviteHoraireDeb>
<periodeActiviteHoraireFin>31/12</periodeActiviteHoraireFin>
<poidsMaxi>20000</poidsMaxi>
<typeDePoint>BPR</typeDePoint>
<codePays>FR</codePays>
<langue>FR</langue>
<libellePays>FRANCE</libellePays>
<loanOfHandlingTool>false</loanOfHandlingTool>
22
<parking>false</parking>
<reseau>R01</reseau>
<distributionSort/>
<lotAcheminement/>
<versionPlanTri/>
</listePointRetraitAcheminement>
<listePointRetraitAcheminement>
<accesPersonneMobiliteReduite>true</accesPersonneMobiliteReduite>
<adresse1>PLACE DU 8 MAI 1945</adresse1>
<adresse2/>
<adresse3/>
<horairesOuvertureDimanche/>
<horairesOuvertureJeudi/>
<horairesOuvertureLundi/>
<horairesOuvertureMardi/>
<horairesOuvertureMercredi/>
<horairesOuvertureSamedi/>
<horairesOuvertureVendredi/>
<localite>DREUX</localite>
<nom>BUREAU DE POSTE DREUX LE MOULEC BP</nom>
<periodeActiviteHoraireDeb/>
<periodeActiviteHoraireFin/>
<langue>FR</langue>
<distributionSort/>
<lotAcheminement/>
<versionPlanTri/>
<qualiteReponse>1</qualiteReponse>
<wsRequestId>dd27dff7e4c6aa57631326cef5a2f8885d88dea1e8cb4db3890eb4f7009266a1</wsRequestId>
<rdv>false</rdv>
</return>
</ns1:findRDVPointRetraitAcheminementResponse>
</soap:Body>
</soap:Envelope>
II.4.2 Méthode findPointRetraitAcheminementByID
II.4.2.1 Paramètres en entrée
Paramètre
accountNumber
Signification
Identifiant du client
Type
Obligatoire
X
23
(NNNNNN)
password
Mot de passe
id
Identifiant du point de
retrait
Référence La Poste
ColiPoste
du
point
(identifiant unique).
date *
weight
filterRelay
Date
l’envoi
estimée
de
Correspond à la date
de commande plus le
délai de préparation de
la commande en jours
ouvrés
Poids du colis
Permet de filtrer les
points commerces de
proximité
Il s'agit du n° de client fourni
par La Poste ColiPoste sur 6
caractères. Numéro du client
remettant les colis, ce
numéro vous a été
communiqué à l'ouverture de
Communiqué à l'ouverture de
X
X
d’étiquetage.
les annonces EDI :
DDD001.
10 caractères
alphanumériques
(JJ/MM/AAAA)
X
(NNNNNN)
Exprimé en grammes
1 caractère alphanumérique
Valeurs possibles 0 ou 1
0 = le filtre est
appliqué, les points ne
sont pas proposés
reseau
1= le filtre n’est pas
appliqué, les points
sont proposés
Identifiant technique
du réseau auquel le
point appartient
3 caractères
alphanumériques
Doit valoir « R12 » si le point
demandé est belge, et laissé
vide pour les points français
24
Langue de restitution
des noms et adresses
des points de retrait
langue
2 caractères
alphanumériques
Valeurs possibles :
FR pour Français (valeur par
défaut)
NL pour Néerlandais**
*Cas particulier de l’utilisation du WebService par les plateformes d’échanges entre
particuliers :
Dans ce cas précis, le processus de vente implique trois acteurs :
•
•
•
le chargeur (site Internet d’échanges),
un vendeur (client du chargeur),
un acheteur (lui aussi client du chargeur).
La « date » correspond ici à la date prévisionnelle d’envoi du colis par le vendeur. Elle
permet d’identifier la disponibilité ou non d’un point de retrait hors domicile. Cette date est
fonction de la date de commande par l’acheteur, et tient compte de différents délais relatifs
à la transaction acheteur/vendeur : éventuel délai de confirmation de vente par le vendeur,
délai d’impression de l’étiquette, délai de dépôt du colis en bureau de Poste, etc.
** Attention : bien que le paramètre NL soit actuellement accepté, les informations des
points de retrait ne sont à ce jour pas mises à disposition en néerlandais. Le déploiement
complet du multilinguisme sera fait dans une version ultérieure.
Exemple d’enveloppe SOAP :
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v2="http://v2.pointretrait.geopost.com/">
<soapenv:Header/>
<soapenv:Body>
<v2:findPointRetraitAcheminementByID>

<accountNumber>123456</accountNumber>

<password>ABC123</password>

<id>850010</id>

<date>26/08/2010</date>

<weight>12500</weight>

<filterRelay >1</filterRelay >
<reseau> </reseau>
<langue>FR</langue>
</v2:findPointRetraitAcheminementByID>
</soapenv:Body>
</soapenv:Envelope>
II.4.2.2 Réponse
C’est une structure SOAP du type pointRetraitAcheminementByIDResult.
25
II.4.2.2.1 Structure pointRetraitAcheminementByIDResult
Paramètre
Signification
Type
errorCode
errorMessage
Code de l’erreur
Libellé de l’erreur
xs:int
xs:string
pointRetraitAche
minement
Information
concernant le point de
retrait recherché
tns:pointRetrait
Acheminement
Commentaires
Voir paragraphe III Codes
erreurs
Structure
pointRetraitAcheminement
II.4.2.2.2 Structure pointRetraitAcheminement
Paramètre
Signification
accesPersonneMobil
iteReduite
Indique si le point
est accessible aux
personnes
à
mobilité réduite
adresse1
adresse2
adresse3
codePostal
congesPartiel
Type
xs:boolean
Spécifique aux points de
retrait bureaux de poste
choisis (BPR).
Numéro et libellé
de la voie du point
Complément
d’adresse du point
Lieu-dit du point
xs:string
Code
point
xs:string
postal
du
Flag indiquant une
fermeture partielle
du point de retrait
Commentaires
xs:string
xs:string
xs:boolean
Peut-être affiché sous forme
de logo (disponible dans la
pictothèque So Colissimo –
voir à la fin de ce
paragraphe II.4.2.2.2 pour
vous le procurer) ou de
libellé. Peut également être
utilisé à des fins de filtre
lors de l’affichage sur le site
marchand.
caractères.
caractères.
caractères.
caractères.
les annonces EDI : le code
postal doit être transmis
dans le rang 5 de
DDD001.
26
sur le délai
garde du colis
congesTotal
de
Flag indiquant une
fermeture
totale
du point de retrait
durant le délai de
garde du colis
de retrait ouverts au moins
7 jours ouvrés (du lundi au
vendredi) durant le délai de
garde du colis.
xs:boolean
Ces points de retrait doivent
être présentés et peuvent
être sélectionnés par
l’acheteur.
de retrait fermés durant la
période de retrait du colis.
Ces points doivent être
présentés mais le
chargeur doit empêcher
leur sélection par le
client.
coordGeolocalisatio
nLatitude
coordGeolocalisatio
nLongitude
distanceEnMetre
Latitude du point
(norme
WGS84
métrique)
Longitude du point
(norme
WGS84
métrique)
Distance en
mètres par
rapport à l’adresse
fournie en entrée
xs:string
xs:int
xs:string
horairesOuvertureL
undi
Horaires
d’ouverture durant
la journée, au
format :
xs:string
Un traitement
différenciateur est
souhaitable (en grisé ou
information « en
congés »par exemple)
caractères
retrait sur un plan.
caractères
retrait de retrait sur un plan.
Ici elle sera égale à -1 car
non calculée
caractères
Une plage horaire non
renseignée équivaut à la
valeur « 00:00-00:00
00:00-00:00 », cette valeur
27
ne doit pas être affichée.
nn:nn-nn:nn
nn:nn-nn:nn
horairesOuvertureM
ardi
horairesOuvertureM
ercredi
horairesOuvertureJ
eudi
horairesOuvertureV
endredi
horairesOuvertureS
amedi
horairesOuvertureD
imanche
identifiant
Une plage horaire sans
coupure dans la journée a la
valeur 0 pour la plage de
l’après-midi (ex : 09:0017:30 00:00-00:00)
xs:string
xs:string
xs:string
xs:string
xs:string
xs:string
Identifiant du
point de retrait
xs:string
d’étiquetage.
Référence
La
Poste ColiPoste du
point (identifiant
unique).
indiceDeLocalisatio
n
Indice permettant
de
localiser
le
point.
Les informations « 00:0000:00 » ne doivent pas être
affichées
caractères
caractères
caractères
caractères
caractères
caractères
xs:string
les annonces EDI :
DDD001.
caractères
L’indice de localisation est
une donnée spécifique aux
points de retrait commerces
de proximité.
Exemple : Près de la gare
listeConges
tns:conges
Il est fortement conseillé
d’afficher sur votre site
marchand tous les champs
d’adresse ainsi que l’indice
de localisation du point de
retrait.
28
localite
nom
ireDeb
ireFin
poidsMaxi
typeDePoint
codePays
langue
libellePays
Commune
du
point
Libellé du point
xs:string
Date de début de
la période durant
laquelle
s’appliquent les
horaires
Date de fin de la
période durant
laquelle
s’appliquent les
horaires
Poids
maximum
autorisé par colis
par le point
xs:string
Type de point
xs:string
caractères (JJ/MM)
xs:int
Exprimé en Kilogrammes
xs:string
Code
pays
du
point de retrait
Langue
libellés du
de retrait
xs:string
des
point
Libellé du pays du
point
Structure Congés
caractères
caractères
caractères (JJ/MM)
xs:string
xs:string
xs:string
Important : Les
points de type ACP et
CDI acceptent les
colis d’un poids allant
jusqu’à 30 kg et 200 cm
en développé3.
caractères
Valeurs possibles :
A2P, CIT, BPR, CDI, ACP,
BDP, ou CMT (voir détails en
I.2.1)
caractères
défaut) ou BE
caractères
défaut) ou NL
Est retourné en français ou
néerlandais en fonction de la
langue demandée en entrée
dans le champ lang
Si le point n’existe pas dans
la langue demandée, il ne
sera pas retourné
29
loanOfHandlingTool
parking
reseau
distributionSort
lotAcheminement
versionPlanTri
Indique si le point
dispose d’outils de
manutention
Indique si le point
dispose d’un
parking
Identifiant
technique du
réseau auquel le
point appartient
Boolean
Boolean
xs:string
Données
d’acheminement
nécessaires pour
les clients utilisant
une solution
d’étiquetage
spécifique SO
LIBERTE.
xs:string
Alphanumérique
sur
3
caractères
Vaut R12 pour les points
belges et R01 à R11 pour les
points français
Alphanumérique
sur
10
caractères
Alphanumérique
sur
10
caractères
caractères
xs:string
xs:string
Se reporter aux
documents
suivants:
2_LIBERTE_Cahier
des Charges Etiquettes So
Colissimo
2_LIBERTE_Spécif
ications
techniques EDI Annonces
Pour les clients
utilisant
une
solution
d’étiquetage
SO
SIMPLICITE ou SO
FLEXIBILITE (Inet,
WS d’étiquetage)
ces
données
seront ignorées.
II.4.2.2.3 Structure Congés
Paramètre
calendarDeDebut
Signification
Date de
congés
début
Type
des
xs:dateTime
Commentaires
Date & Heure GMT au
30
calendarDeFin
Date de fin des congés
xs:dateTime
numero
Numéro d’ordre de la
période de congés sur
une échelle de temps
xs:int
Date & Heure GMT au
Numérique sur 1
caractère
Il peut y avoir de 0 à 3
périodes de congés par
point
Exemple d’enveloppe de retour :
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:findPointRetraitAcheminementByIDResponse xmlns:ns1="http://v2.pointretrait.geopost.com/">
<return>
<pointRetraitAcheminement>
<adresse1>2 RUE DU GENERAL LECLERC</adresse1>
<adresse2/>
<adresse3/>
<coordGeolocalisationLongitude>-1.29712</coordGeolocalisationLongitude>
<distanceEnMetre>-1</distanceEnMetre>
<localite>L AIGUILLON SUR MER</localite>
<nom>BUREAU DE POSTE L AIGUILLON SUR MER BP</nom>
<langue>FR</langue>
<distributionSort/>
<lotAcheminement/>
<versionPlanTri/>
</pointRetraitAcheminement>
</return>
31
</ns1:findPointRetraitAcheminementByIDResponse>
</soap:Body>
</soap:Envelope>
II.5 Interface https
II.5.1 Méthode findRDVPointRetraitAcheminement
II.5.1.1 Paramètres d’entrée HTTPS
Les paramètres d’entrée HTTPS de la méthode findRDVPointRetraitAcheminement sont
les mêmes que ceux listés pour l’interface SOAP au paragraphe II.4.1.1 Paramètres en
entrée.
Exemple de requête:
https://ws.colissimo.fr/pointretrait-wscxf/PointRetraitServiceWS/2.0/findRDVPointRetraitAcheminement?accountNumber=[account
Number]&password=[password]&address=[address]&zipCode=[zipCode]&city=[city]&countr
yCode=[countryCode]&weight=[weight]&shippingDate=[shippingDate]&filterRelay=[filterRel
ay]&requestId=[requestId]&lang=[lang]&optionInter=[optionInter]
Pour ne pas passer un paramètre, il faut supprimer entièrement le paramètre (ne
pas transmettre ce paramètre avec une valeur vide).
Par exemple l’appel suivant est incorrect :
https://ws.colissimo.fr/pointretrait-wscxf/PointRetraitServiceWS/2.0/findRDVPointRetraitAcheminement?accountNumber=123456&
password=ABC123&address&zipCode=75013&city=Paris&countryCode=FR&weight&shipping
Date=29/08/2013&filterRelay=1&requestId=abcdef123456&lang&optionInter
L’appel doit être : https://ws.colissimo.fr/pointretrait-wscxf/PointRetraitServiceWS/2.0/findRDVPointRetraitAcheminement?accountNumber=123456&
password=ABC123&zipCode=75013&city=Paris&countryCode=FR&shippingDate=29/08/201
3&filterRelay=1&requestId=abcdef123456
II.5.1.2 Réponse de la requête
Flux XML identique au flux retourné par l’interface SOAP.
Exemple de retour :
<soap:Envelope>
<soap:Body>
<ns1:findRDVPointRetraitAcheminementResponse>
32
<return>
- <listePointRetraitAcheminement>
<adresse1>23 AVENUE D ITALIE</adresse1>
<adresse2 />
<adresse3 />
<indiceDeLocalisation />
<localite>PARIS</localite>
<nom>PARIS ITALIE</nom>
<langue>FR</langue>
<distributionSort />
<lotAcheminement />
<versionPlanTri />
- <listePointRetraitAcheminement>
<adresse1>19 RUE SIMONE WEIL</adresse1>
<adresse2 />
<adresse3 />
<nom>PARIS OLYMPIADES</nom>
33
<langue>FR</langue>
<lotAcheminement />
<versionPlanTri />
<qualiteReponse>2</qualiteReponse>
<wsRequestId>452d09d30f24bd0fe8f04cb27aa6c38cb2a2e60adad2ef00576e8af00d76e2f6</wsRequestId>
<rdv>true</rdv>
</return>
</ns1:findRDVPointRetraitAcheminementResponse>
</soap:Body>
</soap:Envelope>
II.5.2 Méthode findPointRetraitAcheminementByID
II.5.2.1 Paramètres d’entrée HTTPS
Les paramètres d’entrée HTTPS de la méthode findPointRetraitAcheminementByID sont
les mêmes que ceux listés pour l’interface SOAP au paragraphe II.4.2.1 Paramètres en
entrée.
Exemple de requête:
https://ws.colissimo.fr/pointretrait-wscxf/PointRetraitServiceWS/2.0/findPointRetraitAcheminementByID?accountNumber=[account
Number]&password=[password]&id=[identifiantPoint]&date=[date]&weight=[weight]&filterR
elay=[filterRelay]&reseau=[reseau]&langue=[langue]
Pour ne pas passer un paramètre, il faut supprimer entièrement le paramètre (ne
pas transmettre ce paramètre avec une valeur vide).
Par exemple l’appel suivant est incorrect : https://ws.colissimo.fr/pointretrait-wscxf/PointRetraitServiceWS/2.0/findPointRetraitAcheminementByID?accountNumber=123456
&password=ABC123&id=123456&date=26/08/2013&weight&filterRelay&reseau&langue
L’appel doit être : https://ws.colissimo.fr/pointretrait-wscxf/PointRetraitServiceWS/2.0/findPointRetraitAcheminementByID?accountNumber=123456
&password=ABC123&id=123456&date=26/08/2013&reseau=ABC&langue=FR
34
II.5.2.2 Réponse de la requête
Flux XML identique au flux retourné par l’interface SOAP.
Exemple de retour :
<soap:Envelope >
<soap:Body>
<ns1:findPointRetraitAcheminementByIDResponse >
<return>
- <pointRetraitAcheminement>
<accesPersonneMobiliteReduite>false</accesPersonneMobiliteReduite>
<adresse1>80 RUE LEON FROT</adresse1>
<adresse2 />
<adresse3 />
<distanceEnMetre>-1</distanceEnMetre>
- <listeConges>
<calendarDeDebut>2013-05-20T00:00:00+02:00</calendarDeDebut>
<calendarDeFin>2013-05-20T00:00:00+02:00</calendarDeFin>
<numero>3</numero>
</listeConges>
- <listeConges>
<numero>2</numero>
</listeConges>
- <listeConges>
<numero>1</numero>
</listeConges>
<nom>PARIS MERCOEUR CITYSSIMO</nom>
<typeDePoint>CIT</typeDePoint>
<langue>FR</langue>
<lotAcheminement />
35
<versionPlanTri />
</pointRetraitAcheminement>
</return>
</ns1:findPointRetraitAcheminementByIDResponse>
</soap:Body>
</soap:Envelope>
36
III. Codes erreurs
Il s’agit des valeurs possibles de l’élément <errorCode> présent dans la définition du type
<PointRetraitResult>. La cause de l’erreur est décrite dans l’élément <errorMessage>
associé.
Code erreur
0
101
102
104
105
106
107
117
120
121
122
123
124
125
127
129
143
201
202
203
300
301
1000
Description
Code retour OK
Numéro de compte absent
Mot de passe absent
Code postal absent
Ville absente
Date estimée de l’envoi absente
Identifiant point de retrait absent
Code ISO pays manquant
Poids n’est pas un entier
Poids n’est pas compris entre 1 et 99999
Date n’est pas au format JJ/MM/AAAA
Filtre relais n’est pas 0 ou 1
Identifiant point de retrait incorrect
Code postal incorrect (non compris entre 01XXX et 95XXX ou 980XX)
RequestId incorrect
Adresse incorrecte
Code postal incorrect (format XXXX non respecté)
Identifiant / mot de passe invalide
Service non autorisé pour cet identifiant
Option international non compatible avec le pays
Pas de point de retrait suite à l’application des règles métier
Pas de point de retrait trouvé
Erreur système (erreur technique)
37
IV. Contact
LA POSTE - COLIPOSTE MET A VOTRE DISPOSITION UN SUPPORT, QUE NOUS VOUS INVITONS A CONTACTER DANS
LES CAS SUIVANTS :
Pour toute question technique relative à la solution
décrite dans ce document :
• Le Support Solutions Client,
au 0241.742.088,
du lundi au vendredi, de 9h à 18h.
Etude préalable
Déploiement de la solution
Phase opérationnelle,
après déploiement de la solution
Pour confirmer la solution retenue :
• Votre interlocuteur commercial La Poste –
Coliposte
• Un numéro de dossier vous sera communiqué par
le Support Solutions Client lorsque la demande
sera prise en compte
Pour tout échange concernant la demande de mise en
œuvre :
• Le Support Solutions Client,
au 0241.742.088,
En cas de panne, d’anomalie ou d’incident :
• Le Centre de Service,
au 0825.086.005,
Prononcer « Incident »,
puis « Solutions Web », à l’énoncé des choix
disponibles.
La disponibilité et le bon fonctionnement de nos
systèmes sont supervisés, même en dehors de ces
heures.
38

web service so livraison

Transcription

Documents pareils

Suivi de commande Les colis étant envoyés en COLISSIMO suivi, il

Codification des critères de recherche (I.U.T Clermont 1)

Collège de Chiconi : une mobilisation qui fait avancer la sécurité de

ABONNEMENTS *

Maillot de bain string transbronzant violet bleu 36

Connaître son identifiant iProf et son adresse mail professionnelle

Ashbury Chord Chart.indd

FORMULAIRE DE RETRACTATION - Carter-Cash

caisses CM 812