# API DEVIS COURSIER.FR V3

08/06/2020

[![image-1662457811981.png](https://bookstack.digf.fr/uploads/images/gallery/2022-09/scaled-1680-/image-1662457811981.png)](https://bookstack.digf.fr/uploads/images/gallery/2022-09/image-1662457811981.png)

Version 3.1

##### **Objectif** Obtenir les services, prix, délais, créneaux disponibles à l'instant t ou en différé pour un colisage, une adresse d'enlèvement et une adresse de livraison donnés. L'appel à cet API permet notamment d'afficher les créneaux disponibles sur un site internet. Il est toutefois possible de passer une commande par l'API Passage de commande (order) sans appeler au préalable l'API Devis (getprice). ##### **Protocole** Les requests se font en mode https à l’url api.coursier.fr/v3/getprice.php, on récupère un json contenant la liste des services/créneaux disponibles qui peuvent être choisis pour passer la commande. ##### **Authentification** L'authentification se fait à l'aide d'une apikey associée à votre user coursier.fr, vous pouvez trouver ces informations dans votre espace client. Vous devez disposez d'un compte en facturation mensuelle, si ce n'est pas encore le cas vous pouvez contacter un commercial à l'adresse . Vous devez passer en paramètre l'apikey, le user et le compte client utilisé, un même user pouvant être rattaché à plusieurs comptes client. Afin de tester nos apis, vous pouvez utiliser le compte de test suivant pour réaliser vos développements dès à présent en attendant d'avoir vos accès définitifs : User : Pass : T3stCFR\* ClientId : 7055339 Apikey : e1ab1411d66765e73cf4b068d39cda8a ##### **Paramètres Les paramètres sont à passer en POST sous forme d’un tableau json.

NOM	REQUIS	TYPE	DESCRIPTIF
User	O	Varchar(180)	User d'accès aux interfaces coursier.fr
Apikey	O	Varchar(32)	apikey liée à votre user d'accès aux interfaces coursier.fr
ClientId	O	int	Numéro de compte client
StartDate	N	datetime	Par défaut égale à maintenant, permet de spécifier une date en différé par exemple pour tenir compte d'un cutoff. Format « YYYY-MM-DD HH:MM:SS ».
FromAddress.Address	O	Varchar(120)	Numéro et rue de l'adresse d'enlèvement
FromAddress.PostalCode	O	Varchar(10)	Code Postal de l’adresse d’enlèvement
FromAddress.City	O	Varchar(50)	Ville d’enlèvement
FromAddress.Country	O	Varchar(50)	Pays d’enlèvement en toutes lettres (exemple : France)
ToAddress.Address	O	Varchar(120)	Numéro et rue de l'adresse de livraison
ToAddress.PostalCode	O	Varchar(10)	Code Postal de l’adresse de livraison
ToAddress.City	O	Varchar(50)	Ville de livraison
ToAddress.Country	O	Varchar(50)	Pays de livraison en toutes lettres (exemple : France)
Packages	O	Array()	Tableau des colis
Lang	N	Varchar(2)	Code langue sur deux caractères pour l'affichage des libellés, est égal à FR par défaut

Packages :

NOM	REQUIS	TYPE	DESCRIPTIF
Name	O	Varchar(32)	Texte libre : nature du colis (Pli, Colis, Sac, Palette...) Pour des raisons de sécurité, éviter de préciser une nature d'objet dans le cas de marchandise à forte valeur (montre, bijou...)
NumberOfPackage	O	Int	Nombre de colis similaires
Weight	O	double	Poids unitaire en kilos
Length	O	Double	Longueur unitaire en cm
Width	O	double	Largeur unitaire en cm
Height	O	Double	Hauteur en cm

Si vous ne disposez pas des mesures précises de vos envois, vous pouvez vous référer à la grille standard ci dessous

Name	Weight	Length	Width	Height	Exemple
XS	1	30	20	5	Pli
S	3	30	25	25	Petit Colis
M	5	40	30	30	Moyen colis
L	15	60	40	40	Gand Colis
XL	100	80	60	100	Demi Palette
XXL	250	80	120	100	Palette

Les colisages erronées peuvent entrainer un supplément et un retard de livraison

##### **Réponse JSON La réponse est un tableau json contenant les différents services possibles, leur prix et les délais associés. Pour les créneaux, la réponse contient une ligne par créneau disponible, chaque ligne ayant un service\_id identique. En cas d'erreur, l'api répond un json contenant un champ Message précisant la nature de l'erreur.

NOM	Taille	DESCRIPTIF
ServiceId	int	id du service concerné, cet id est à utiliser par la suite pour le passage de commande
Service	Varchar(100)	Libellé du service dans la langue passée en paramètre
PickupStartDate	Datetime	début du créneau d’enlèvement
PickupEndDate	Datetime	fin du créneau d’enlèvement
DeliveryStartDate	Datetime	debut du créneau de livraison
DeliveryEndDate	Datetime	fin du créneau de livraison
Price	Float	Prix HT de la prestation

##### **Exemple d'appel** ```PHP 'test@apicfr.fr', 'Apikey' => 'e1ab1411d66765e73cf4b068d39cda8a', 'ClientId' => '7055339', 'StartDate' => '', 'FromAddress' => array('Address' => '45 Rue la Boétie', 'PostalCode' => '75008', 'City' => 'Paris', 'Country' => 'France'), 'ToAddress' => array('Address' => '50 Rue Maurice Arnoux', 'PostalCode' => '92120', 'City' => 'Montrouge', 'Country' => 'France'), 'Packages' => array(array('Name' => 'M', 'NumberOfPackage' => 1, 'Weight' =>5, 'Length' => '40', 'Width' => '30', 'Height' => '30')), 'Lang' => 'FR', ); $datajson = json_encode($data); $curl = curl_init(); curl_setopt($curl, CURLOPT_URL, $url); curl_setopt($curl, CURLOPT_POST, 1); curl_setopt($curl, CURLOPT_POSTFIELDS, $datajson); curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type:application/json')); curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1); $res = curl_exec($curl); curl_close($curl); var_dump($res); ?> ``` ##### **Exemple de Réponse**

\[{"ServiceId":"1","Service":"Normal","PickupStartDate":"2020-06-26 15:25:00","PickupEndDate":"2020-06-26 19:25:00","DeliveryStartDate":"2020-06-26 16:25:00","DeliveryEndDate":"2020-06-26 19:25:00","Price":"24.0"},{"ServiceId":"2","Service":"Exclu","PickupStartDate":"2020-06-26 15:25:00","PickupEndDate":"2020-06-26 17:40:00","DeliveryStartDate":"2020-06-26 15:25:00","DeliveryEndDate":"2020-06-26 17:40:00","Price":"38.0"},{"ServiceId":"3","Service":"Double exclu","PickupStartDate":"2020-06-26 15:25:00","PickupEndDate":"2020-06-26 16:40:00","DeliveryStartDate":"2020-06-26 15:25:00","DeliveryEndDate":"2020-06-26 16:40:00","Price":"56.0"},{"ServiceId":"10","Service":"Créneau 2h direct","PickupStartDate":"2020-06-26 17:00:00","PickupEndDate":"2020-06-26 18:00:00","DeliveryStartDate":"2020-06-26 18:00:00","DeliveryEndDate":"2020-06-26 20:00:00","Price":"18.0"},{"ServiceId":"10","Service":"Créneau 2h direct","PickupStartDate":"2020-06-26 19:00:00","PickupEndDate":"2020-06-26 20:00:00","DeliveryStartDate":"2020-06-26 20:00:00","DeliveryEndDate":"2020-06-26 22:00:00","Price":"18.0"},{"ServiceId":"10","Service":"Créneau 2h direct","PickupStartDate":"2020-06-27 07:00:00","PickupEndDate":"2020-06-27 08:00:00","DeliveryStartDate":"2020-06-27 08:00:00","DeliveryEndDate":"2020-06-27 10:00:00","Price":"18.0"},{"ServiceId":"10","Service":"Créneau 2h direct","PickupStartDate":"2020-06-27 09:00:00","PickupEndDate":"2020-06-27 10:00:00","DeliveryStartDate":"2020-06-27 10:00:00","DeliveryEndDate":"2020-06-27 12:00:00","Price":"18.0"},{"ServiceId":"10","Service":"Créneau 2h direct","PickupStartDate":"2020-06-27 11:00:00","PickupEndDate":"2020-06-27 12:00:00","DeliveryStartDate":"2020-06-27 12:00:00","DeliveryEndDate":"2020-06-27 14:00:00","Price":"18.0"},{"ServiceId":"10","Service":"Créneau 2h direct","PickupStartDate":"2020-06-27 13:00:00","PickupEndDate":"2020-06-27 14:00:00","DeliveryStartDate":"2020-06-27 14:00:00","DeliveryEndDate":"2020-06-27 16:00:00","Price":"18.0"},{"ServiceId":"10","Service":"Créneau 2h direct","PickupStartDate":"2020-06-27 15:00:00","PickupEndDate":"2020-06-27 16:00:00","DeliveryStartDate":"2020-06-27 16:00:00","DeliveryEndDate":"2020-06-27 18:00:00","Price":"18.0"},{"ServiceId":"10","Service":"Créneau 2h direct","PickupStartDate":"2020-06-27 17:00:00","PickupEndDate":"2020-06-27 18:00:00","DeliveryStartDate":"2020-06-27 18:00:00","DeliveryEndDate":"2020-06-27 20:00:00","Price":"18.0"},{"ServiceId":"10","Service":"Créneau 2h direct","PickupStartDate":"2020-06-27 19:00:00","PickupEndDate":"2020-06-27 20:00:00","DeliveryStartDate":"2020-06-27 20:00:00","DeliveryEndDate":"2020-06-27 22:00:00","Price":"18.0"},{"ServiceId":"10","Service":"Créneau 2h direct","PickupStartDate":"2020-06-28 07:00:00","PickupEndDate":"2020-06-28 08:00:00","DeliveryStartDate":"2020-06-28 08:00:00","DeliveryEndDate":"2020-06-28 10:00:00","Price":"27.0"},{"ServiceId":"10","Service":"Créneau 2h direct","PickupStartDate":"2020-06-28 09:00:00","PickupEndDate":"2020-06-28 10:00:00","DeliveryStartDate":"2020-06-28 10:00:00","DeliveryEndDate":"2020-06-28 12:00:00","Price":"27.0"},{"ServiceId":"10","Service":"Créneau 2h direct","PickupStartDate":"2020-06-28 11:00:00","PickupEndDate":"2020-06-28 12:00:00","DeliveryStartDate":"2020-06-28 12:00:00","DeliveryEndDate":"2020-06-28 14:00:00","Price":"27.0"},{"ServiceId":"10","Service":"Créneau 2h direct","PickupStartDate":"2020-06-28 13:00:00","PickupEndDate":"2020-06-28 14:00:00","DeliveryStartDate":"2020-06-28 14:00:00","DeliveryEndDate":"2020-06-28 16:00:00","Price":"27.0"},{"ServiceId":"10","Service":"Créneau 2h direct","PickupStartDate":"2020-06-28 15:00:00","PickupEndDate":"2020-06-28 16:00:00","DeliveryStartDate":"2020-06-28 16:00:00","DeliveryEndDate":"2020-06-28 18:00:00","Price":"27.0"},{"ServiceId":"10","Service":"Créneau 2h direct","PickupStartDate":"2020-06-28 17:00:00","PickupEndDate":"2020-06-28 18:00:00","DeliveryStartDate":"2020-06-28 18:00:00","DeliveryEndDate":"2020-06-28 20:00:00","Price":"27.0"},{"ServiceId":"10","Service":"Créneau 2h direct","PickupStartDate":"2020-06-28 19:00:00","PickupEndDate":"2020-06-28 20:00:00","DeliveryStartDate":"2020-06-28 20:00:00","DeliveryEndDate":"2020-06-28 22:00:00","Price":"27.0"},{"ServiceId":"10","Service":"Créneau 2h direct","PickupStartDate":"2020-06-29 07:00:00","PickupEndDate":"2020-06-29 08:00:00","DeliveryStartDate":"2020-06-29 08:00:00","DeliveryEndDate":"2020-06-29 10:00:00","Price":"18.0"},{"ServiceId":"10","Service":"Créneau 2h direct","PickupStartDate":"2020-06-29 09:00:00","PickupEndDate":"2020-06-29 10:00:00","DeliveryStartDate":"2020-06-29 10:00:00","DeliveryEndDate":"2020-06-29 12:00:00","Price":"18.0"},{"ServiceId":"10","Service":"Créneau 2h direct","PickupStartDate":"2020-06-29 11:00:00","PickupEndDate":"2020-06-29 12:00:00","DeliveryStartDate":"2020-06-29 12:00:00","DeliveryEndDate":"2020-06-29 14:00:00","Price":"18.0"},{"ServiceId":"10","Service":"Créneau 2h direct","PickupStartDate":"2020-06-29 13:00:00","PickupEndDate":"2020-06-29 14:00:00","DeliveryStartDate":"2020-06-29 14:00:00","DeliveryEndDate":"2020-06-29 16:00:00","Price":"18.0"},{"ServiceId":"10","Service":"Créneau 2h direct","PickupStartDate":"2020-06-29 15:00:00","PickupEndDate":"2020-06-29 16:00:00","DeliveryStartDate":"2020-06-29 16:00:00","DeliveryEndDate":"2020-06-29 18:00:00","Price":"18.0"},{"ServiceId":"10","Service":"Créneau 2h direct","PickupStartDate":"2020-06-29 17:00:00","PickupEndDate":"2020-06-29 18:00:00","DeliveryStartDate":"2020-06-29 18:00:00","DeliveryEndDate":"2020-06-29 20:00:00","Price":"18.0"},{"ServiceId":"10","Service":"Créneau 2h direct","PickupStartDate":"2020-06-29 19:00:00","PickupEndDate":"2020-06-29 20:00:00","DeliveryStartDate":"2020-06-29 20:00:00","DeliveryEndDate":"2020-06-29 22:00:00","Price":"18.0"},{"ServiceId":"22","Service":"Créneau 2h navette","PickupStartDate":"2020-06-26 16:00:00","PickupEndDate":"2020-06-26 17:00:00","DeliveryStartDate":"2020-06-26 18:00:00","DeliveryEndDate":"2020-06-26 20:00:00","Price":"18.0"},{"ServiceId":"22","Service":"Créneau 2h navette","PickupStartDate":"2020-06-26 16:00:00","PickupEndDate":"2020-06-26 17:00:00","DeliveryStartDate":"2020-06-26 20:00:00","DeliveryEndDate":"2020-06-26 22:00:00","Price":"18.0"},{"ServiceId":"22","Service":"Créneau 2h navette","PickupStartDate":"2020-06-26 16:00:00","PickupEndDate":"2020-06-26 17:00:00","DeliveryStartDate":"2020-06-27 08:00:00","DeliveryEndDate":"2020-06-27 10:00:00","Price":"18.0"},{"ServiceId":"22","Service":"Créneau 2h navette","PickupStartDate":"2020-06-26 16:00:00","PickupEndDate":"2020-06-26 17:00:00","DeliveryStartDate":"2020-06-27 10:00:00","DeliveryEndDate":"2020-06-27 12:00:00","Price":"18.0"},{"ServiceId":"22","Service":"Créneau 2h navette","PickupStartDate":"2020-06-26 16:00:00","PickupEndDate":"2020-06-26 17:00:00","DeliveryStartDate":"2020-06-27 12:00:00","DeliveryEndDate":"2020-06-27 14:00:00","Price":"18.0"},{"ServiceId":"22","Service":"Créneau 2h navette","PickupStartDate":"2020-06-26 16:00:00","PickupEndDate":"2020-06-26 17:00:00","DeliveryStartDate":"2020-06-27 14:00:00","DeliveryEndDate":"2020-06-27 16:00:00","Price":"18.0"},{"ServiceId":"22","Service":"Créneau 2h navette","PickupStartDate":"2020-06-26 16:00:00","PickupEndDate":"2020-06-26 17:00:00","DeliveryStartDate":"2020-06-27 16:00:00","DeliveryEndDate":"2020-06-27 18:00:00","Price":"18.0"},{"ServiceId":"22","Service":"Créneau 2h navette","PickupStartDate":"2020-06-27 16:00:00","PickupEndDate":"2020-06-27 17:00:00","DeliveryStartDate":"2020-06-27 18:00:00","DeliveryEndDate":"2020-06-27 20:00:00","Price":"18.0"},{"ServiceId":"22","Service":"Créneau 2h navette","PickupStartDate":"2020-06-27 16:00:00","PickupEndDate":"2020-06-27 17:00:00","DeliveryStartDate":"2020-06-27 20:00:00","DeliveryEndDate":"2020-06-27 22:00:00","Price":"18.0"},{"ServiceId":"22","Service":"Créneau 2h navette","PickupStartDate":"2020-06-27 16:00:00","PickupEndDate":"2020-06-27 17:00:00","DeliveryStartDate":"2020-06-28 08:00:00","DeliveryEndDate":"2020-06-28 10:00:00","Price":"27.0"},{"ServiceId":"22","Service":"Créneau 2h navette","PickupStartDate":"2020-06-27 16:00:00","PickupEndDate":"2020-06-27 17:00:00","DeliveryStartDate":"2020-06-28 10:00:00","DeliveryEndDate":"2020-06-28 12:00:00","Price":"27.0"},{"ServiceId":"22","Service":"Créneau 2h navette","PickupStartDate":"2020-06-27 16:00:00","PickupEndDate":"2020-06-27 17:00:00","DeliveryStartDate":"2020-06-28 12:00:00","DeliveryEndDate":"2020-06-28 14:00:00","Price":"27.0"},{"ServiceId":"22","Service":"Créneau 2h navette","PickupStartDate":"2020-06-27 16:00:00","PickupEndDate":"2020-06-27 17:00:00","DeliveryStartDate":"2020-06-28 14:00:00","DeliveryEndDate":"2020-06-28 16:00:00","Price":"27.0"},{"ServiceId":"22","Service":"Créneau 2h navette","PickupStartDate":"2020-06-27 16:00:00","PickupEndDate":"2020-06-27 17:00:00","DeliveryStartDate":"2020-06-28 16:00:00","DeliveryEndDate":"2020-06-28 18:00:00","Price":"27.0"},{"ServiceId":"22","Service":"Créneau 2h navette","PickupStartDate":"2020-06-28 16:00:00","PickupEndDate":"2020-06-28 17:00:00","DeliveryStartDate":"2020-06-28 18:00:00","DeliveryEndDate":"2020-06-28 20:00:00","Price":"27.0"},{"ServiceId":"22","Service":"Créneau 2h navette","PickupStartDate":"2020-06-28 16:00:00","PickupEndDate":"2020-06-28 17:00:00","DeliveryStartDate":"2020-06-28 20:00:00","DeliveryEndDate":"2020-06-28 22:00:00","Price":"27.0"},{"ServiceId":"22","Service":"Créneau 2h navette","PickupStartDate":"2020-06-28 16:00:00","PickupEndDate":"2020-06-28 17:00:00","DeliveryStartDate":"2020-06-29 08:00:00","DeliveryEndDate":"2020-06-29 10:00:00","Price":"18.0"},{"ServiceId":"22","Service":"Créneau 2h navette","PickupStartDate":"2020-06-28 16:00:00","PickupEndDate":"2020-06-28 17:00:00","DeliveryStartDate":"2020-06-29 10:00:00","DeliveryEndDate":"2020-06-29 12:00:00","Price":"18.0"},{"ServiceId":"22","Service":"Créneau 2h navette","PickupStartDate":"2020-06-28 16:00:00","PickupEndDate":"2020-06-28 17:00:00","DeliveryStartDate":"2020-06-29 12:00:00","DeliveryEndDate":"2020-06-29 14:00:00","Price":"18.0"},{"ServiceId":"22","Service":"Créneau 2h navette","PickupStartDate":"2020-06-28 16:00:00","PickupEndDate":"2020-06-28 17:00:00","DeliveryStartDate":"2020-06-29 14:00:00","DeliveryEndDate":"2020-06-29 16:00:00","Price":"18.0"},{"ServiceId":"22","Service":"Créneau 2h navette","PickupStartDate":"2020-06-28 16:00:00","PickupEndDate":"2020-06-28 17:00:00","DeliveryStartDate":"2020-06-29 16:00:00","DeliveryEndDate":"2020-06-29 18:00:00","Price":"18.0"},{"ServiceId":"22","Service":"Créneau 2h navette","PickupStartDate":"2020-06-29 16:00:00","PickupEndDate":"2020-06-29 17:00:00","DeliveryStartDate":"2020-06-29 18:00:00","DeliveryEndDate":"2020-06-29 20:00:00","Price":"18.0"},{"ServiceId":"22","Service":"Créneau 2h navette","PickupStartDate":"2020-06-29 16:00:00","PickupEndDate":"2020-06-29 17:00:00","DeliveryStartDate":"2020-06-29 20:00:00","DeliveryEndDate":"2020-06-29 22:00:00","Price":"18.0"}\]