Book a ride
Header Parameters
Bearer token auth which can be used instead of sending the b2bpartner_id and key in payload
Body Parameters
(Deprecated) Partner name as provided by hoppa contact. This field is deprecated — use b2bpartner_id instead.
b2bpartner_id provided by hoppa. Use this field instead of the deprecated partner field.
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.
"quote_id" provided from the quote response. Please refer to the "Ride Quotes" documentation. This is only for ride booking for road transportation
A reference number or code for the ride booking. This reference is how the partner identifies the ride booking in their system
The total price or cost of the ride.
Show child attributes
Number of child seats required
Number of infant seats required
Number of toddler seats required
The starting location or point of origin for the ride.
Show child attributes
The destination location or endpoint of the ride.
Show child attributes
The class or type of vehicle for the ride.
This is the lead passenger object
Show child attributes
Show child attributes
"time" 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_time" 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/
Duration of the ride.
Whether a meet-and-greet service is requested for the ride.
yesnoArrival flight information
Show child attributes
Departure flight information
Show child attributes
This is to identify a ride as a round trip if there are 2 trips, if not defined it will appear as a charter ride
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. if any of the parameter are missing at the trip level , it takes the parameter from the root level.
Show child attributes
Response
Success
Response Attributes
Unique Reference for the ride from hoppa
Show child attributes
Empty body request
Response Attributes
No key in body
Response Attributes
System error
Response Attributes
Train request
unique request id
partner name as provided by hoppa contact
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.
quote identifier for the quotes api
unique reference for the ride
The trips array, one trip object for each journey
Show child attributes
Show child attributes
Show child attributes
One Way (Request)
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Round Trip (Request)
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Hourly Ride (request)
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Multiday Ride (Request)
Show child attributes
Show child attributes
Show child attributes
Ride hailing
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Base URL
Production:
Sandbox:
Response