Dates, formats & versioning

Dates, times and time zones

Value	Format	Time zone
Search arrival_date, departure_date, pickup_date, return_date	YYYY-MM-DD	–
Search arrival_time, departure_time, pickup_time, return_time	HH:MM (24 h)	Local time of the pickup, no offset
Offer pickup_datetime	YYYY-MM-DDTHH:MM[:SS]	Local time of the pickup, no offset; null on airport offers
Book flight_info.flight_datetime	YYYY-MM-DDTHH:MM[:SS]	Local time of the airport
Booking details trip.pickup_datetime, trip.flight.datetime, cancellation.free_cancellation_until	ISO 8601	Local, with offset when known (for example +05:30)
Booking details trip.timezone	IANA name, for example Asia/Kolkata	–
booking.booked_at, cancelled_at	ISO 8601 with +00:00	UTC

Point-to-point and hourly dates and times are validated (422 when malformed). Airport search dates and times are passed to providers as sent, so always use exactly these formats.

Enumerations

Field	Values
Search transfer_type	airport (default), point_to_point (alias intercity), hourly
Airport source_type	air, hotel, geo
Point-to-point trip_type	one_way (default), round_trip
Offer direction (airport)	arrival, departure
Offer leg	outbound, return, round_trip
Offer pricing_model	fixed_route, hourly_package, outstation_package
Book status	completed, pending, failed, unknown
Booking details status (the lookup)	ok, failed
booking.status	confirmed, pending, cancellation_pending, cancelled, failed, unknown
Cancel status	cancelled, cancellation_pending, failed, unknown
refund_source	supplier, policy_estimate
cancelled_at_source	supplier, tp_cancel
flight_info.flight_type	domestic, international
provider	The provider ids enabled for your key, as returned in offers and listed on your onboarding sheet. Treat them as opaque strings. Examples in this documentation use neutral ids (provider_a, provider_b, …).

Error codes are listed on the Errors page.

Glossary

Term	Meaning
Provider	A ground-transport company whose offers the API returns
Offer	One bookable vehicle option for one leg, from one provider
Leg	One ride: airport arrival / departure, or outbound / return / round_trip
Lead passenger	The traveller the driver and provider contact
Recheck	The availability and price check before booking
Opaque token	An encrypted string (offer_token, supplier_reference.booking_token) you store and send back unchanged; it cannot be read or edited and works only with your API key
Sandbox	The test environment, with test keys and test bookings

Versioning

• The major version is in the path (/v1/). Within v1, changes are backwards compatible: new optional request fields, new response fields, new enumeration values, new error codes and new providers can appear at any time. Your client must ignore unknown fields and handle unknown enumeration values.
• Breaking changes go to a new major version (/v2/), announced in advance, with both versions running in parallel during a migration period.
• booking_details.details_version versions the booking details structure (currently "3").
• Deprecated items (/v1/transfer/voucher, voucher_data) keep working in v1; remove them from your integration.

Changes are listed in the Changelog.