# API GETPRICE COURSIER.FR V7 (EN)

<table border="1" id="bkmrk-08%2F06%2F2020-version-3" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 33.3333%;">19/08/2026</td><td style="width: 33.3333%;">[![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)</td><td class="align-right" style="width: 33.3333%;">Version 7.1</td></tr></tbody></table>

#####   


##### **Objective**

Retrieve available services, prices, delays, slots for an immediate or scheduled pickup for a given shipment, pick-up address and delivery address. Placing an order via the "Order API" does not require calling this "GetPrice API" beforehand, but we recommend doing so, especially to display available slots on a website.

##### **Protocol**

Requests are made via HTTPS using the url <u>api.coursier.fr/v7/getprice.php</u>. The response is a JSON containing the list of services/available slots which can be chosen to place the order.

##### **Authentication**

Authentication is done using an API key associated with your coursier.fr user account. Please contact our sales team at <commercial@coursier.fr> to obtain credentials. A monthly billing account is required.

The following parameters are required for authentication: Apikey, ClientId, User. Note that a single user may be linked to several customer accounts.

To test our APIs, you may use the following testing account to begin your developing tasks while waiting for your final credentials:

User : <test@apicfr.fr>

ClientId : 7055339

Apikey : e1ab1411d66765e73cf4b068d39cda8a

##### **Parameters**

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

<table id="bkmrk-nom-requis-type-desc" style="width: 0px; height: 960.149px;" width="614"><tbody><tr style="height: 35.3984px;"><td style="width: 222px; height: 35.3984px;">**NOM**

</td><td style="width: 107px; height: 35.3984px;">**REQUIRED**

</td><td style="width: 116px; height: 35.3984px;">**TYPE**

</td><td style="width: 357px; height: 35.3984px;">**DESCRIPTIF**

</td></tr><tr style="height: 57.7969px;"><td style="width: 222px; height: 57.7969px;">User

</td><td style="width: 107px; height: 57.7969px;">Y

</td><td style="width: 116px; height: 57.7969px;">Varchar(180)

</td><td style="width: 357px; height: 57.7969px;">User email to access coursier.fr interface

</td></tr><tr style="height: 57.7969px;"><td style="width: 222px; height: 57.7969px;">Apikey

</td><td style="width: 107px; height: 57.7969px;">Y

</td><td style="width: 116px; height: 57.7969px;">Varchar(32)

</td><td style="width: 357px; height: 57.7969px;">Apikey linked to your user

</td></tr><tr style="height: 57.7969px;"><td style="width: 222px; height: 57.7969px;">ClientId

</td><td style="width: 107px; height: 57.7969px;">Y

</td><td style="width: 116px; height: 57.7969px;">int

</td><td style="width: 357px; height: 57.7969px;">Customer account number

</td></tr><tr style="height: 102.594px;"><td style="width: 222px; height: 102.594px;">StartDate

</td><td style="width: 107px; height: 102.594px;">N

</td><td style="width: 116px; height: 102.594px;">datetime

</td><td style="width: 357px; height: 102.594px;">Default value is now.

For direct deliveries a delayed date can be specified to take into account for a cutoff time.

For slot-based deliveries StartDate has to be expected delivery slot start date

Format « YYYY-MM-DD HH:MM:SS ».

</td></tr><tr style="height: 35.3984px;"><td style="width: 222px; height: 35.3984px;">FromAddress.Latitude

</td><td style="width: 107px; height: 35.3984px;">Y/N

</td><td style="width: 116px; height: 35.3984px;">Decimal(9,7)

</td><td style="width: 357px; height: 35.3984px;">Optional if address fields (Address, PostalCode, City, Country) are specified. Required if address fields are null.

</td></tr><tr style="height: 35.3984px;"><td style="width: 222px; height: 35.3984px;">FromAddress.Longitude

</td><td style="width: 107px; height: 35.3984px;">Y/N

</td><td style="width: 116px; height: 35.3984px;">Decimal(9,7)

</td><td style="width: 357px; height: 35.3984px;">Optional if address fields (Address, PostalCode, City, Country) are specified. Required if address fields are null.

</td></tr><tr style="height: 57.7969px;"><td style="width: 222px; height: 57.7969px;">FromAddress.Address

</td><td style="width: 107px; height: 57.7969px;">Y/N

</td><td style="width: 116px; height: 57.7969px;">Varchar(120)

</td><td style="width: 357px; height: 57.7969px;">Number and street of pick-up address

Can be null if Latitude/Longitude are specified

</td></tr><tr style="height: 57.7969px;"><td style="width: 222px; height: 57.7969px;">FromAddress.PostalCode

</td><td style="width: 107px; height: 57.7969px;">Y/N

</td><td style="width: 116px; height: 57.7969px;">Varchar(10)

</td><td style="width: 357px; height: 57.7969px;">Zipcode of pick-up address

Can be null if Latitude/Longitude are specified

</td></tr><tr style="height: 57.7969px;"><td style="width: 222px; height: 57.7969px;">FromAddress.City

</td><td style="width: 107px; height: 57.7969px;">Y/N

</td><td style="width: 116px; height: 57.7969px;">Varchar(50)

</td><td style="width: 357px; height: 57.7969px;">Pick-up city

Can be null if Latitude/Longitude are specified

</td></tr><tr style="height: 57.7969px;"><td style="width: 222px; height: 57.7969px;">FromAddress.Country

</td><td style="width: 107px; height: 57.7969px;">Y/N

</td><td style="width: 116px; height: 57.7969px;">Varchar(50)

</td><td style="width: 357px; height: 57.7969px;">Pick-up country in full (example : France)

Can be null if Latitude/Longitude are specified

</td></tr><tr><td style="width: 222px;">ToAddress.Latitude

</td><td style="width: 107px;">Y/N

</td><td style="width: 116px;">Decimal(9,7)

</td><td style="width: 357px;">Optional if address fields (Address, PostalCode, City, Country) are specified. Required if address fields are null.

</td></tr><tr><td style="width: 222px;">ToAddress.Longitude

</td><td style="width: 107px;">Y/N

</td><td style="width: 116px;">Decimal(9,7)

</td><td style="width: 357px;">Optional if address fields (Address, PostalCode, City, Country) are specified. Required if address fields are null.

</td></tr><tr style="height: 57.7969px;"><td style="width: 222px; height: 57.7969px;">ToAddress.Address

</td><td style="width: 107px; height: 57.7969px;">Y/N

</td><td style="width: 116px; height: 57.7969px;">Varchar(120)

</td><td style="width: 357px; height: 57.7969px;">Number and street of shipping address

Can be null if Latitude/Longitude are specified

</td></tr><tr style="height: 57.7969px;"><td style="width: 222px; height: 57.7969px;">ToAddress.PostalCode

</td><td style="width: 107px; height: 57.7969px;">Y/N

</td><td style="width: 116px; height: 57.7969px;">Varchar(10)

</td><td style="width: 357px; height: 57.7969px;">Zipcode of shipping address

Can be null if Latitude/Longitude are specified

</td></tr><tr style="height: 57.7969px;"><td style="width: 222px; height: 57.7969px;">ToAddress.City

</td><td style="width: 107px; height: 57.7969px;">Y/N

</td><td style="width: 116px; height: 57.7969px;">Varchar(50)

</td><td style="width: 357px; height: 57.7969px;">Shipping city

Can be null if Latitude/Longitude are specified

</td></tr><tr style="height: 57.7969px;"><td style="width: 222px; height: 57.7969px;">ToAddress.Country

</td><td style="width: 107px; height: 57.7969px;">Y/N

</td><td style="width: 116px; height: 57.7969px;">Varchar(50)

</td><td style="width: 357px; height: 57.7969px;">Shipping country in full (example : France)

Can be null if Latitude/Longitude are specified

</td></tr><tr style="height: 57.7969px;"><td style="width: 222px; height: 57.7969px;">Packages

</td><td style="width: 107px; height: 57.7969px;">Y

</td><td style="width: 116px; height: 57.7969px;">Array()

</td><td style="width: 357px; height: 57.7969px;">Array containing the packages

</td></tr><tr style="height: 57.7969px;"><td style="width: 222px; height: 57.7969px;">Lang

</td><td style="width: 107px; height: 57.7969px;">N

</td><td style="width: 116px; height: 57.7969px;">Varchar(2)

</td><td style="width: 357px; height: 57.7969px;">Language code for the display of labels, default value is FR.

</td></tr></tbody></table>

<u>Packages :</u>

<table id="bkmrk-nom-requis-type-desc-0" style="width: 806px;" width="614"><tbody><tr><td style="width: 224px;">**NAME**

</td><td style="width: 110px;">**REQUIRED**

</td><td style="width: 118px;">**TYPE**

</td><td style="width: 354px;">**DESCRIPTION**

</td></tr><tr><td style="width: 224px;">Name

</td><td style="width: 110px;">Y

</td><td style="width: 118px;">Varchar(32)

</td><td style="width: 354px;">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)

</td></tr><tr><td style="width: 224px;">NumberOfPackage

</td><td style="width: 110px;">Y

</td><td style="width: 118px;">Int

</td><td style="width: 354px;">Amount of similar packages

</td></tr><tr><td style="width: 224px;">Weight

</td><td style="width: 110px;">Y

</td><td style="width: 118px;">double

</td><td style="width: 354px;">Unit weight in kg

</td></tr><tr><td style="width: 224px;">Length

</td><td style="width: 110px;">Y

</td><td style="width: 118px;">Double

</td><td style="width: 354px;">Unit length in cm

</td></tr><tr><td style="width: 224px;">Width

</td><td style="width: 110px;">Y

</td><td style="width: 118px;">double

</td><td style="width: 354px;">Unit width in cm

</td></tr><tr><td style="width: 224px;">Height

</td><td style="width: 110px;">Y

</td><td style="width: 118px;">Double

</td><td style="width: 354px;">Unit height in cm

</td></tr></tbody></table>

<p class="callout info">If you lack the exact measurements of your packages, you may refer to the standard grid below.</p>

<table border="1" id="bkmrk-name-weight-length-w" style="border-collapse: collapse; width: 62.963%;"><tbody><tr><td class="align-center" style="width: 10.2545%;">Name</td><td class="align-center" style="width: 8.70514%;">Weight</td><td class="align-center" style="width: 8.74895%;">Length</td><td class="align-center" style="width: 8.49439%;">Width</td><td class="align-center" style="width: 10.1401%;">Height</td><td class="align-center" style="width: 15.3074%;">Example</td></tr><tr><td class="align-center" style="width: 10.2545%;">XS</td><td class="align-center" style="width: 8.70514%;">1</td><td class="align-center" style="width: 8.74895%;">30</td><td class="align-center" style="width: 8.49439%;">20</td><td class="align-center" style="width: 10.1401%;">5</td><td class="align-center" style="width: 15.3074%;">Fold</td></tr><tr><td class="align-center" style="width: 10.2545%;">S</td><td class="align-center" style="width: 8.70514%;">3</td><td class="align-center" style="width: 8.74895%;">30</td><td class="align-center" style="width: 8.49439%;">25</td><td class="align-center" style="width: 10.1401%;">25</td><td class="align-center" style="width: 15.3074%;">Small package</td></tr><tr><td class="align-center" style="width: 10.2545%;">M</td><td class="align-center" style="width: 8.70514%;">5</td><td class="align-center" style="width: 8.74895%;">40</td><td class="align-center" style="width: 8.49439%;">30</td><td class="align-center" style="width: 10.1401%;">30</td><td class="align-center" style="width: 15.3074%;">Medium package</td></tr><tr><td class="align-center" style="width: 10.2545%;">L</td><td class="align-center" style="width: 8.70514%;">15</td><td class="align-center" style="width: 8.74895%;">60</td><td class="align-center" style="width: 8.49439%;">40</td><td class="align-center" style="width: 10.1401%;">40 </td><td class="align-center" style="width: 15.3074%;">Big package</td></tr><tr><td class="align-center" style="width: 10.2545%;">XL</td><td class="align-center" style="width: 8.70514%;">100</td><td class="align-center" style="width: 8.74895%;">80</td><td class="align-center" style="width: 8.49439%;">60</td><td class="align-center" style="width: 10.1401%;">100</td><td class="align-center" style="width: 15.3074%;">Half pallet</td></tr><tr><td class="align-center" style="width: 10.2545%;">XXL</td><td class="align-center" style="width: 8.70514%;">250</td><td class="align-center" style="width: 8.74895%;">80</td><td class="align-center" style="width: 8.49439%;">120</td><td class="align-center" style="width: 10.1401%;">100</td><td class="align-center" style="width: 15.3074%;">Pallet</td></tr></tbody></table>

<p class="callout danger">Wrong package measurements may lead to a supplement and a delivery delay.</p>

##### **JSON Response**

The response is a JSON array containing the different available services, their price and the associated timelines. For slots, the response includes one line for each available 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.

<table id="bkmrk-nom-taille-descripti" style="width: 810px;"><tbody><tr><td style="width: 225px;">**NAME**

</td><td style="width: 116px;">**TYPE**

</td><td style="width: 469px;">**DESCRIPTION**

</td></tr><tr><td style="width: 225px;">ServiceId

</td><td style="width: 116px;">int

</td><td style="width: 469px;">ID of the service, will be needed to place the order

</td></tr><tr><td style="width: 225px;">Service

</td><td style="width: 116px;">Varchar(100)

</td><td style="width: 469px;">Label of the service in the language chosen

</td></tr><tr><td style="width: 225px;">PickupStartDate

</td><td style="width: 116px;">Datetime

</td><td style="width: 469px;">Beginning of the pick-up slot

</td></tr><tr><td style="width: 225px;">PickupEndDate

</td><td style="width: 116px;">Datetime

</td><td style="width: 469px;">End of the pick-up slot

</td></tr><tr><td style="width: 225px;">DeliveryStartDate

</td><td style="width: 116px;">Datetime

</td><td style="width: 469px;">Beginning of the shipping slot

</td></tr><tr><td style="width: 225px;">DeliveryEndDate

</td><td style="width: 116px;">Datetime

</td><td style="width: 469px;">End of the shipping slot

</td></tr><tr><td style="width: 225px;">Price

</td><td style="width: 116px;">Float

</td><td style="width: 469px;">Pre-tax price of the delivery

</td></tr></tbody></table>

##### **Example1 - Payload with latitude/longitude**

```JSON
{<br></br>    "User": "corporate.service@deliveroo.fr",<br></br>    "Apikey": "f933511046beb0224470d8cbecec82a2",<br></br>    "ClientId": "8245027",<br></br>    "StartDate": "2026-08-20 13:00:00",<br></br>    "FromAddress": {<br></br>        "Latitude": "48.8713882",<br></br>        "Longitude": "2.3204516"<br></br>    },<br></br>    "ToAddress": {<br></br>        "Latitude": "48.8763882",<br></br>        "Longitude": "2.3294516"<br></br>    },<br></br>    "Packages": [<br></br>        {<br></br>            "Name": "Deliveroo Box",<br></br>            "NumberOfPackage": 3,<br></br>            "Weight": 10,<br></br>            "Length": 56,<br></br>            "Width": 37,<br></br>            "Height": 21<br></br>        }<br></br>    ],<br></br>    "Lang":"FR"<br></br>}
```

##### **Example2 - Payload with full address**

```JSON
{<br></br>    "User": "corporate.service@deliveroo.fr",<br></br>    "Apikey": "f933511046beb0224470d8cbecec82a2",<br></br>    "ClientId": "8245027",<br></br>    "StartDate": "2026-08-20 13:00:00",<br></br>    "FromAddress": {<br></br>        "Address": "33 Rue Rodier",<br></br>        "PostalCode": "75009",<br></br>        "City": "Paris",<br></br>        "Country": "France"<br></br>    },<br></br>    "ToAddress": {<br></br>        "Address": "33 Rue La Fayette",<br></br>        "PostalCode": "75009",<br></br>        "City": "Paris",<br></br>        "Country": "France"<br></br>    },<br></br>    "Packages": [<br></br>        {<br></br>            "Name": "Deliveroo Box",<br></br>            "NumberOfPackage": 3,<br></br>            "Weight": 10,<br></br>            "Length": 56,<br></br>            "Width": 37,<br></br>            "Height": 21<br></br>        }<br></br>    ]<br></br>}
```

##### **Response**

```JSON
[{"ServiceId":"97","Service":"Scheduled catering delivery","PickupStartDate":"2026-08-20 12:30:00",<br></br>  "PickupEndDate":"2026-08-20 12:50:00","DeliveryStartDate":"2026-08-20 12:45:00","DeliveryEndDate":"2026-08-20 13:15:00","Price":"18.15"}]
```

#####   