Theme switcher

Ride Quotes

Header Parameters

Authorizationstring Required

Bearer token auth which can be used instead of sending the b2bpartner_id and key in payload

Body Parameters

partnerstring Required

Deprecated. Partner name as provided by hoppa contact. This field is deprecated and will be removed in a future version. Please use b2bpartner_id instead.

b2bpartner_idstring Required

The b2b partner ID provided by hoppa. Use this field for authentication instead of the deprecated partner field.

keystring Required

This key is provided by your Hoppa contact. Note that separate keys are issued for the sandbox and production environments. Be sure to use the appropriate key depending on the environment you are working in.

fromobject Required

The starting location of the ride.

toobject Required

The destination of the ride.

durationnumber

An hourly ride is a ride priced based on its duration. This parameter is mandatory if the ride is quoted as hourly. The duration is measured in minutes.

request_idstring

some request id from partner, a unique string per request preferably

currencystring

Specify the currency using a 3-letter code as defined by the ISO 4217 standard (e.g., USD for US Dollar, EUR for Euro, JPY for Japanese Yen).

timenumber Required

This parameter is the pickup date and time of ride. "time" is specified in epoch time, or unix time, which is the number of seconds that have elapsed since 00:00:00 UTC on 1 January 1970. For more information on epoch time refer to: https://www.epochconverter.com/

return_timenumber

This parameter is the return date and time of ride. "return_time" is specified in epoch time, or unix time, which is the number of seconds that have elapsed since 00:00:00 UTC on 1 January 1970. For more information on epoch time refer to: https://www.epochconverter.com/

passenger_countnumber

Total passenger count for the ride, including adults, infants and children.

children_countnumber

The total number of children accompanying the user for the ride quote.

infant_countnumber

The number of infants accompanying the user for the ride quote.

toddler_countnumber

The number of toddlers accompanying the user for the ride quote.

vehicle_classstring

the vehicle class should be provided as train when requesting for train availability

tripsarray

The trips array represents the legs of a multi-day journey. Each object in the array corresponds to a single trip. If trips is not provided, the ride is treated as a standard one-way, round trip or hourly booking.

Response

200
Object

Success

Response Attributes

vehicle_classesarray Required

List of available vehicle classes for the ride.

tripsarray
meet_and_greetobject

Charges for meet and greet service if requested while booking a ride

add_serviceobject

Indicates if the number of additional service requested in ride quotes will have the price for the respective price for the ride quote

add_service_unit_priceobject

The unit price for additional services added to the ride quote.

messagesobject

Any additional messages related to the ride quote.

langsarray

The language preferences specified for the ride quote, indicating the desired language for communication during the ride.

quote_idstring Required

The unique identifier assigned to the ride quote generated by the POST partner-rides/quotes endpoint.

request_idstring Required

The unique identifier assigned to the ride request associated with the ride quote.

400
Object

Wrong partner or wrong partner name

Response Attributes

errCodenumber
errMsgstring
500
Object

System failure

Response Attributes

errCodenumber
errMsgstring

Train Request

partnerstring Required

partner name as provided by hoppa contact

b2bpartner_idstring
keystring Required

This key is provided by your Hoppa contact. Note that separate keys are issued for the sandbox and production environments. Be sure to use the appropriate key depending on the environment you are working in.

vehicle_classstring

vehicle class

fromobject Required
toobject Required
request_idstring

unique request id

currencystring Required

Specify the currency using a 3-letter code as defined by the ISO 4217 standard (e.g., USD for US Dollar, EUR for Euro, JPY for Japanese Yen).

timenumber Required

This parameter is the departure date and time of ride. "time" is specified in epoch time, or unix time, which is the number of seconds that have elapsed since 00:00:00 UTC on 1 January 1970. For more information on epoch time refer to: https://www.epochconverter.com/

return_timenumber

This parameter is the return date and time of ride. "return_time" is specified in epoch time, or unix time, which is the number of seconds that have elapsed since 00:00:00 UTC on 1 January 1970. For more information on epoch time refer to: https://www.epochconverter.com/

passenger_countnumber

the total number of passengers

Train Response

vehicle_classesarray Required

List of available vehicle classes for the ride.

quote_idstring Required

The unique identifier assigned to the ride quote generated by the POST partner-rides/quotes endpoint.

request_idstring

The unique identifier assigned to the ride request associated with the ride quote.

One way (Request)

partnerstring
b2bpartner_idstring
keystring
request_idstring
fromobject
toobject
timenumber

One way (Response)

vehicle_classesarray
tripsarray
meet_and_greetobject
add_serviceobject
add_service_unit_priceobject
langsarray
quote_idstring
request_idstring

Round Trip (Request)

partnerstring
b2bpartner_idstring
keystring
request_idstring
fromobject
toobject
timenumber
return_timenumber

Round Trip (Response)

vehicle_classesarray
tripsarray
meet_and_greetobject
add_serviceobject
add_service_unit_priceobject
langsarray
quote_idstring
request_idstring

Hourly (Request)

partnerstring
b2bpartner_idstring
keystring
request_idstring
fromobject
toobject
durationnumber

Hourly (Response)

vehicle_classesarray
tripsarray
meet_and_greetobject
add_serviceobject
add_service_unit_priceobject
langsarray
quote_idstring
request_idstring

Ride hailing (Request)

partnerstring
b2bpartner_idstring
keystring
request_idstring
fromobject
toobject
timestring

Ride Hailing (response)

vehicle_classesarray
distancenumber
durationnumber
searchResultIdstring

multiday rides(request)

partnerstring
b2bpartner_idstring
keystring
request_idstring
toddler_countnumber
child_countnumber
infant_countnumber
currencystring
tripsarray

multiday rides(response)

vehicle_classesarray
add_service_unit_priceobject
add_serviceobject
meet_and_greetobject
langsarray
quote_idstring
request_idstring
Was this section helpful?
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 { "partner": "partner-name-as-provided-by-hoppa", "b2bpartner_id": "b2bpartner_id-provided-by-hoppa", "key": "api-key-as-provided-by-hoppa", "vehicle_class": "train", "from": { "lat": 37.621313, "lng": -122.378955, "name": "London Heathrow Station", "address": "London heathrow Station Terminal 5" }, "to": { "lat": 37.8711583, "lng": -122.336457, "name": "London Paddington", "address": "London Paddington Station" }, "request_id": "unique-request-id", "currency": "USD", "time": 1784622685, "return_time": 1785622685, "passenger_count": 5 }

POST

/

Select
1

Response

Was this section helpful?