Ground Transport Bookings
Book a vehicle for your users, poll for confirmation, and manage reservations.
Ground Transport Bookings
After polling a search and selecting a result_id, book the vehicle and poll for confirmation. All requests carry the white-label headers Authorization: Bearer <JWT>, X-App-Id, and X-Environment.
Create Booking
POST /v1/travel/ground-transport/bookings
Book a vehicle from the search results using the quote you selected from the poll response. Returns a prebooking_id — proceed to payment (perk redemption or /initiate-payment), then poll for booking confirmation.
| Field | Type | Required | Description |
|---|---|---|---|
search_id | string | yes | From the search endpoint |
quote_id | string | yes | The selected quote's id, from the search poll response |
vehicle_type | string | yes | The selected quote's vehicle_type (e.g. "Sedan", "SUV") — copy it verbatim from the poll response. This is what renders as "Car type" on the reservation/voucher/admin panel. Always send the exact value from the quote you booked — don't hardcode or guess it, and don't leave it blank even though the server durably re-derives it server-side as of 2026-08-25 as a fallback. |
price | number | yes | The selected quote's price value, from the poll response |
first_name | string | yes | Passenger first name |
last_name | string | yes | Passenger last name |
email | string | yes | Passenger email |
country_code_name | string | yes | 2-letter ISO country code for phone_number (e.g. "GB") |
phone_number | string | yes | Passenger phone, min 7 digits |
flight_number | string | no | For airport pickups — enables flight tracking |
airline | string | no | Required together with flight_number when the quote's flight_info_required is true |
https://cloud.vanitypass.com with X-Environment: Sandbox. No real bookings or charges. Production access: contact us./v1/travel/ground-transport/bookingsSandbox credentials
Keys never leave your browser — they are sent only to cloud.vanitypass.com with X-Environment: Sandbox.
curl -X POST 'https://cloud.vanitypass.com/v1/travel/ground-transport/bookings' \
-H 'Content-Type: application/json' \
-H 'X-Environment: Sandbox' \
-d '{"search_id":"srch_example","quote_id":"res_example","vehicle_type":"Sedan","price":62.62,"first_name":"Jane","last_name":"Doe","email":"jane@example.com","country_code_name":"GB","phone_number":"+447700900000","flight_number":"BA123","airline":"British Airways"}'Poll Booking Confirmation
GET /v1/travel/ground-transport/bookings/{search_id}/poll
Repeat every 2 seconds until status is confirmed or failed.
| Path param | Description |
|---|---|
search_id | ID returned by the book endpoint |
https://cloud.vanitypass.com with X-Environment: Sandbox. No real bookings or charges. Production access: contact us./v1/travel/ground-transport/bookings/{search_id}/pollSandbox credentials
Keys never leave your browser — they are sent only to cloud.vanitypass.com with X-Environment: Sandbox.
curl -X GET 'https://cloud.vanitypass.com/v1/travel/ground-transport/bookings/{search_id}/poll' \
-H 'Content-Type: application/json' \
-H 'X-Environment: Sandbox' \Cancel Booking
POST /v1/travel/ground-transport/bookings/cancel
Cancel a confirmed or pending booking.
| Field | Type | Required | Description |
|---|---|---|---|
booking_id | string | yes | Booking to cancel |
https://cloud.vanitypass.com with X-Environment: Sandbox. No real bookings or charges. Production access: contact us./v1/travel/ground-transport/bookings/cancelSandbox credentials
Keys never leave your browser — they are sent only to cloud.vanitypass.com with X-Environment: Sandbox.
curl -X POST 'https://cloud.vanitypass.com/v1/travel/ground-transport/bookings/cancel' \
-H 'Content-Type: application/json' \
-H 'X-Environment: Sandbox' \
-d '{"booking_id":"book_example"}'Booking History
GET /v1/travel/ground-transport/bookings/history
Returns the authenticated user's past ground transport bookings.
https://cloud.vanitypass.com with X-Environment: Sandbox. No real bookings or charges. Production access: contact us./v1/travel/ground-transport/bookings/historySandbox credentials
Keys never leave your browser — they are sent only to cloud.vanitypass.com with X-Environment: Sandbox.
curl -X GET 'https://cloud.vanitypass.com/v1/travel/ground-transport/bookings/history' \ -H 'Content-Type: application/json' \ -H 'X-Environment: Sandbox' \