API – Wiki LimouRATE

API DOCUMENTATION

Content overview

General

General

Date values are transferred in local time.
The interface expects the format: [yyyy-MM-dd HH:mm]
Required fields are marked with (m).

Token

In case of System2System endpoint, LimouRATE uses a token.

The token can be sent to the server in two different ways:

As part of an url: {token}
As part of the http header: X-Auth-Token

To get your token please login to your LimouRATE account at:
https://rate.limourate.com

Select „Master Data“ in the menu bar.

You will find the field „Token“ as the second entry.

Endpoint

https://rate.limousolution.com/RATE/ServiceRate/{function}/{token}

Error codes

Error type

401 SC_UNAUTHORIZED

400 SC_BAD_REQUEST

Description

Invalid token

Please check the error message, for more information

LimouRATE wiki

https://wiki.limourate.com

LimouRATE Portal

https://rate.limourate.com

Functions

GetQuotationsShare
Get rates of the eligible providers for the available vehicle categories.

GetQuotationsSales
Get rates based on the own sales price list

GetQuotationsShare

This request sends the required booking data to the LimouRATE server.

The response contains the rates of the eligible providers for the available vehicle categories.

Endpoint

https://rate.limourate.com/RATE/ServiceRate/getQuotationShare/{token}

HTTP Request Type

POST

Request

Field name

invoiceCountry

pickupAddress

dropoffAddress

service

duration

distance

language

pickupLatLng

dropoffLatLng

pickupTimestamp

googlekey

token

detailedResult

distanceunit

Data type

String

Double

String

Double

Description

Country Code (ISO 3166-1) DE, US, ..

Pickup address

Dropoff address

Point-To-Point / Hourly

Job duration (if hourly booking) in hours

Distance pickup -> dropoff

Language [de/en]

Lat/Lon separated by comma

Pickup date/ time (yyyy-mm-dd HH:mm)

Own google maps API key

Own account token

Yes/No

km/miles

Mandatory

Yes

if hourly

Yes

Response

Object: tQuotationData

Field name

quotations

Data type

List<tQuoteData>

Description

List or result per category and supplier

Object: tQuoteData

Field name

category

categoryID

gnetCategoryID

durationPickup

roundtripDistance

roundtripDuration

distanceA

distanceB

distanceM

supplierName

supplierGnetID

supplierLocationAdresse

supplierLocationGps

totalNet

totalGross

prices

Data type

String

Double

String

Double

String

Double

List<tPrice>

Description

Ignored

Duration garage -> pickup

Total distance

Total duration

Distance garage -> pickup

Distance dropoff -> garage

Distance pickup -> dropoff

Supplier name

Supplier GNet ID

Supplier Location (i.e. 1470 Bank St)

Supplier Location Lat/Lon

Price net

Price gross

Description of detailed prices

Object: tPrice

Field name

description

discount

amount

SinglePrice

net

vat

gross

Data type

String

Double

Description

Discount, optional

The amount multiplied by the single price gives the net price

Single price

Total net price (excl. VAT)

VAT value in percent (e.g. 7 or 19)

Total gross (incl. VAT)

Example

RequestQuotationShare

https://rate.limourate.com/RATE/ServiceRate/getQuotationShare/{token}

{
    "invoiceCountry": "DE",
    "pickupAddress": null,
    "dropoffAddress": null,
    "service": "Point-To-Point",
    "duration": 0,
    "distance": 10.481,
    "language": "en",
    "pickupLatLng": "53.632105,10.005516",
    "dropoffLatLng": "53.55706,10.004731",
    "pickupTimestamp": "2022-11-14 09:55",
    "googleKey": "AIXXXXX...XXXXxE",
    "token": "234XXXXX-XXXX-XXXX-XXXX-XXXXXXb35cec",
    "detailedResult": "No",
    "distanceUnit": "km"
}

ResponseQuotationShare

{ 
   "quotations": [     
       {
            "category": "First Class Limousine (max. 3 Pax)",
            "categoryID": "cc36cb1f-XXXX-XXXX-XXX-XXXXXX5c42d",
            "gnetCategoryID": "First Class Limousine (max. 3 Pax)",
            "durationPickup": 194.85,
            "roundtripDistance": 592.0,
            "roundtripDuration": 420.0,
            "distanceA": 293.965,
            "distanceB": 287.931,
            "distanceM": 10.482,
            "supplierName": "Supplier Name",
            "supplierGnetID": "",
            "supplierLocationAdresse": "Berlin, Deutschland",
            "supplierLocationGps": "52.5200066,13.404954",
            "totalNet": 640.0,
            "totalGross": 640.0,
            "prices": [
                {
                    "description": "Point-To-Point",
                    "discount": 0.0,
                    "amount": 1.0,
                    "singlePrice": 640.0,
                    "net": 640.0,
                    "vat": 0.0,
                    "gross": 640.0
                }
            ]
        },
        {
            "category": "Business-Class-Van (max 8 Pax)",
            "categoryID": "bde4c5f3-XXX-4816-YYYY-4f5c021c6549",
            "gnetCategoryID": "VAN_8",
            "durationPickup": 335.6166666666667,
            "roundtripDistance": 1025.0,
            "roundtripDuration": 690.0,
            "distanceA": 517.247,
            "distanceB": 496.846,
            "distanceM": 10.482,
            "supplierName": "John Doe Limousines",
            "supplierGnetID": "supplierGNet",
            "supplierLocationAdresse": "Frankfurt",
            "supplierLocationGps": "50.1109221,8.6821267",
            "totalNet": 3125.0,
            "totalGross": 3718.75,
            "prices": [
                {
                    "description": "Point-To-Point",
                    "discount": 0.0,
                    "amount": 1.0,
                    "singlePrice": 3125.0,
                    "net": 3125.0,
                    "vat": 19.0,
                    "gross": 3718.75
                }
            ]
        },
        {
            "category": "Business-Class-Limousine (max 3 Pax)",
            "categoryID": "57b2d8fc-XXXX-XXXX-XXXX-XXXXX299f22e",
            "gnetCategoryID": "SEDAN",
            "durationPickup": 335.6166666666667,
            "roundtripDistance": 1025.0,
            "roundtripDuration": 690.0,
            "distanceA": 517.247,
            "distanceB": 496.846,
            "distanceM": 10.482,
            "supplierName": "John Doe Limousines",
            "supplierGnetID": "supplierGNet",
            "supplierLocationAdresse": "Frankfurt",
            "supplierLocationGps": "50.1109221,8.6821267",
            "totalNet": 2100.0,
            "totalGross": 2499.0,
            "prices": [
                {
                    "description": "Point-To-Point",
                    "discount": 0.0,
                    "amount": 1.0,
                    "singlePrice": 2100.0,
                    "net": 2100.0,
                    "vat": 19.0,
                    "gross": 2499.0
                }
            ]
        },
        {
            "category": "First-Class-Limousine (max 3 PAX)",
            "categoryID": "6dad830e-XXXX-XXXX-XXXX-XXXXXX4301b3e",
            "gnetCategoryID": "SEDAN_LUX",
            "durationPickup": 335.6166666666667,
            "roundtripDistance": 1025.0,
            "roundtripDuration": 690.0,
            "distanceA": 517.247,
            "distanceB": 496.846,
            "distanceM": 10.482,
            "supplierName": "John Doe Limousines",
            "supplierGnetID": "supplierGNet",
            "supplierLocationAdresse": "Frankfurt",
            "supplierLocationGps": "50.1109221,8.6821267",
            "totalNet": 3135.0,
            "totalGross": 3730.6499999999996,
            "prices": [
                {
                    "description": "Point-To-Point",
                    "discount": 0.0,
                    "amount": 1.0,
                    "singlePrice": 3135.0,
                    "net": 3135.0,
                    "vat": 19.0,
                    "gross": 3730.6499999999996
                }
            ]
        }
    ]
}

GetQuotationsSales

This function is used when the LimouRATE user has stored his own sales price list in LimouRATE and his reservation system requests these prices from LimouRATE via the API.

Endpoint

https://rate.limourate.com/RATE/ServiceRate/getQuotationSales/{token}

HTTP Request Type

POST

Request

Field name

invoiceCountry

pickupAddress

dropoffAddress

service

duration

distance

language

pickupLatLng

dropoofLatLng

pickupTimestamp

googlekey

token

pricelistID

comission

incremental

surchargePurchase

detailedResult

distanceunit

Data type

String

Double

String

Double

String

Description

Country Code (ISO 3166-1) DE, US, ..

Pickup address

Dropoff address

Point-To-Point / Hourly

Job duration (if hourly booking) in hours

Distance pickup -> dropoff

Language [de/en]

Lat/Lon separated by comma

Pickup date/ time (yyyy-mm-dd HH:mm)

Own google maps API key

Own account token

GUID of applicable price list

Comission to be taken into account in %

1=60 min., 2=30 min., 3=20 min., ..

Sales margin in % (if the sales price = pruchase price + margin in %)

Yes/No

„km“ or „miles“

Mandatory

Yes

if hourly

Yes

Response

Object: tQuotationData

Field name

quotations

Data type

List<tQuoteData>

Description

List or result per category and supplier

Object: tQuoteData

Field name

category

categoryID

gnetCategoryID

durationPickup

roundtripDistance

roundtripDuration

distanceA

distanceB

distanceM

supplierGnetID

supplierLocationAdresse

supplierLocationGps

totalNet

totalGross

prices

Data type

String

Double

String

Double

String

Double

List<tPrices>

Description

Ignored

Duration garage -> pickup

Total distance

Total duration

Distance garage -> pickup

Distance dropoff -> garage

Distance pickup -> dropoff

Supplier GNet ID

Supplier Location (i.e. 1470 Bank St)

Supplier Location Lat/Lon

Price net

Price gross

Description of detailed prices

Object: tPrice

Field name

description

discount

amount

SinglePrice

net

vat

gross

Data type

String

Double

Description

Description, e.g. „Point-To-Point“

Discount in %, optional

The amount multiplied by the single price gives the net price

Single price

Total net price (excl. VAT)

VAT value in percent (e.g. 7 or 19)

Total gross (incl. VAT)

Example

RequestQuotationSales

https://rate.limourate.com/RATE/ServiceRate/getQuotationSales/{token}

{
    "invoiceCountry": "DE",
    "pickupAddress": null,
    "dropoffAddress": null,
    "service": "Point-To-Point",
    "duration": 0,
    "distance": 10.481,
    "language": "en",
    "pickupLatLng": "53.632105,10.005516",
    "dropoffLatLng": "53.55706,10.004731",
    "pickupTimestamp": "2022-11-14 09:55",
    "googleKey": "AIXXXXX...XXXXxE",
    "token": "2340XXXX-XXXX-XXXX-XXXX-XXXXXX5cec",
    "priceListID" : "48baXXXXX-XXXX-XXXX-XXXX-XXXXXXc518ea",
    "discount": 0,
    "provision": 0,
    "incremental": 2,
    "surchargePurchase" : 20,
    "detailedResult": "No",
    "distanceUnit": "km"
}

ResponseQuotationSales

{
    "quotations": [
        {
            "category": "Business-Class-Limousine (max. 3 PAX)",
            "categoryID": "7706931c-XXXX-XXXX-XXXX-XXXX7eddd3d2",
            "gnetCategoryID": "SEDAN",
            "durationPickup": 109.34278523189366,
            "roundtripDistance": 309.0,
            "roundtripDuration": 240.0,
            "distanceA": 152.469,
            "distanceB": 146.435,
            "distanceM": 10.482,
            "supplierGnetID": "",
            "supplierLocationAdresse": "Am Kugelberg 15, 19406 Sternberg, Germany",
            "supplierLocationGps": "53.7060709,11.836358",
            "totalNet": 803.4,
            "totalGross": 956.0459999999999,
            "prices": [
                {
                    "description": "Point-To-Point",
                    "discount": 0.0,
                    "amount": 1.0,
                    "singlePrice": 803.4,
                    "net": 803.4,
                    "vat": 19.0,
                    "gross": 956.0459999999999
                }
            ]
        },
        {
            "category": "First-Class-Limousine (max. 3 PAX)",
            "categoryID": "7706931c-XXXX-XXXX-XXXX-XXXX7eddd3d2",
            "gnetCategoryID": "SEDAN_LUX",
            "durationPickup": 109.34278523189366,
            "roundtripDistance": 309.0,
            "roundtripDuration": 240.0,
            "distanceA": 152.469,
            "distanceB": 146.435,
            "distanceM": 10.482,
            "supplierGnetID": "",
            "supplierLocationAdresse": "Am Kugelberg 15, 19406 Sternberg, Germany",
            "supplierLocationGps": "53.7060709,11.836358",
            "totalNet": 1205.1,
            "totalGross": 1434.0689999999997,
            "prices": [
                {
                    "description": "Point-To-Point",
                    "discount": 0.0,
                    "amount": 1.0,
                    "singlePrice": 1205.1,
                    "net": 1205.1,
                    "vat": 19.0,
                    "gross": 1434.0689999999997
                }
            ]
        },
        {
            "category": "Business-Class-Van (max. 8 PAX)",
            "categoryID": "7706931c-XXXX-XXXX-XXXX-XXXX7eddd3d2",
            "gnetCategoryID": "VAN_8",
            "durationPickup": 109.34278523189366,
            "roundtripDistance": 309.0,
            "roundtripDuration": 240.0,
            "distanceA": 152.469,
            "distanceB": 146.435,
            "distanceM": 10.482,
            "supplierGnetID": "",
            "supplierLocationAdresse": "Am Kugelberg 15, 19406 Sternberg, Germany",
            "supplierLocationGps": "53.7060709,11.836358",
            "totalNet": 927.0,
            "totalGross": 1103.1299999999999,
            "prices": [
                {
                    "description": "Point-To-Point",
                    "discount": 0.0,
                    "amount": 1.0,
                    "singlePrice": 927.0,
                    "net": 927.0,
                    "vat": 19.0,
                    "gross": 1103.1299999999999
                }
            ]
        },
        {
            "category": "First-Class-Van (max. 7 PAX)",
            "categoryID": "7706931c-XXXX-XXXX-XXXX-XXXX7eddd3d2",
            "gnetCategoryID": "VAN_MINI_7",
            "durationPickup": 109.34278523189366,
            "roundtripDistance": 309.0,
            "roundtripDuration": 240.0,
            "distanceA": 152.469,
            "distanceB": 146.435,
            "distanceM": 10.482,
            "supplierGnetID": "",
            "supplierLocationAdresse": "Am Kugelberg 15, 19406 Sternberg, Germany",
            "supplierLocationGps": "53.7060709,11.836358",
            "totalNet": 1112.4,
            "totalGross": 1323.756,
            "prices": [
                {
                    "description": "Point-To-Point",
                    "discount": 0.0,
                    "amount": 1.0,
                    "singlePrice": 1112.4,
                    "net": 1112.4,
                    "vat": 19.0,
                    "gross": 1323.756
                }
            ]
        }
    ]
}