API GETPRICE COURSIER.FR V3 (EN)

08/06/2020

Version 3.1

Objective

Obtain the services, prices, delays, slots available at time T or delayed for a given packing, pick-up address and delivery address. Calling this API notably allows to display the available slots on a website. It is however possible to place an order through the API Passage de commande (order) without calling the API Devis (getprice) beforehand.

Protocol

Requests are made via HTTPS with the url api.coursier.fr/v3/getprice.php, the response is a JSON containing the list of services/available slots which can be chosen to place the order.

Authentication

The authentication happens with an apikey paired to your coursier.fr user, these informations can be found in your customer area. You must have a monthly billing account, if it is not the case, you may contact a salesman at commercial@coursier.fr. You must give as parameters the apikey, the user and the customer account used (a user can be associated with several customer accounts).

In order to test our APIs, as of now you may use the following testing account to begin your developping tasks while you wait for your definitive credentials :

User : test@apicfr.fr

Pass : T3stCFR*

ClientId : 7055339

Apikey : e1ab1411d66765e73cf4b068d39cda8a

Parameters

Parameters must be send in a JSON array using the POST method.

NOM	REQUIRED	TYPE	DESCRIPTIF
User	Y	Varchar(180)	User to access the coursier.fr interfaces
Apikey	Y	Varchar(32)	Apikey linked to your user
ClientId	Y	int	Customer account number
StartDate	N	datetime	Default value is now. Allows to specify a delayed date to take into accout a cutoff for example. Format « YYYY-MM-DD HH:MM:SS ».
FromAddress.Address	Y	Varchar(120)	Number and street of pick-up address
FromAddress.PostalCode	Y	Varchar(10)	Zipcode of pick-up address
FromAddress.City	Y	Varchar(50)	Pick-up city
FromAddress.Country	Y	Varchar(50)	Pick-up country in full (example : France)
ToAddress.Address	Y	Varchar(120)	Number and street of shipping address
ToAddress.PostalCode	Y	Varchar(10)	Zipcode of shipping address
ToAddress.City	Y	Varchar(50)	Shipping city
ToAddress.Country	Y	Varchar(50)	Shipping country in full (example : France)
Packages	Y	Array()	Array containing the packages
Lang	N	Varchar(2)	Language code for the display of labels, default value is FR.

Packages :

NAME	REQUIRED	TYPE	DESCRIPTION
Name	Y	Varchar(32)	Free text : nature of the package (folds, parcel, bag, pallet...) For safety reasons, avoid mentioning the contents when it is of high value (jewelry, etc)
NumberOfPackage	Y	Int	Amount of similar packages
Weight	Y	double	Unit weight in kg
Length	Y	Double	Unit length in cm
Width	Y	double	Unit width in cm
Height	Y	Double	Unit height in cm

If you lack the exact measurements of your packages, you may refer to the standard grid below.

Name	Weight	Length	Width	Height	Example
XS	1	30	20	5	Fold
S	3	30	25	25	Small package
M	5	40	30	30	Medium package
L	15	60	40	40	Big package
XL	100	80	60	100	Half pallet
XXL	250	80	120	100	Pallet

Wrong package measurements may lead to a supplement and a delivery delay.

JSON Response

The response is a JSON array containing the different available services, their price and the associated timelines. For the slots, the response includes one line for each avaiable slot, each line having a matching service_id. In case of error, the API returns a JSON with a Message field specifying the nature of the error.

NAME	TYPE	DESCRIPTION
ServiceId	int	ID of the service, will be needed to place the order
Service	Varchar(100)	Label of the service in the language chosen
PickupStartDate	Datetime	Beginning of the pick-up slot
PickupEndDate	Datetime	End of the pick-up slot
DeliveryStartDate	Datetime	Beginning of the shipping slot
DeliveryEndDate	Datetime	End of the shipping slot
Price	Float	Pre-tax price of the delivery

API call example

<?php

$Url = "https://api.coursier.fr/v3/getprice.php";
$Data = array('User' => '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);

?>

Response example

[{"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"}]

API GETPRICE COURSIER.FR V3 (EN)

Objective

Protocol

Authentication

Parameters

JSON Response

API call example

Response example

No Comments