TransferSearchResponse

Offers from all providers queried, plus per-provider errors.

request_idstringrequired

Id of this search. Quote it to support.

Example: 3e51940a-7b52-5ffe-a1c2-f7604038365d

transfer_typestring

airport, point_to_point or hourly.

Default value: airport

Example: airport

offers object[]

Offers, all in the requested currency, sorted by price ascending.

Array [

providerstringrequired

Provider of the offer. Send it as provider_context.provider.

Example: provider_d

transfer_typestring

airport, point_to_point or hourly.

Default value: airport

Example: airport

directionstringrequired

Airport: arrival or departure. Point-to-point and hourly: the leg (outbound, return, round_trip).

Example: arrival

offer_idstringrequired

Id of the offer within this search response. A new id is generated on every search: do not store it across searches.

Example: 1421a5071cc20000

rate_keystringrequired

Send it as provider_context.rate_key to recheck and book.

Example: 7

offer_tokenstring | nullnullable

Opaque, encrypted string. Store it and send it back unchanged; it cannot be read or edited (a modified token is rejected with 422). Send it as provider_context.offer_token to recheck. Valid for 24 hours from the search (409 offer_expired afterwards); only for your API key.

Example: ot1.gAAAAAB...opaque-offer-token...(about 1 kB; trimmed in this example)

price objectrequired

Price for the vehicle.

totalnumberrequired

Total price for the vehicle.

Example: 1317

currencystringrequired

ISO 4217 currency: the requested currency.

Example: INR

taxes_includedboolean

Always true: prices include taxes.

Default value: true

Example: true

vehicle object

Vehicle category.

anyOf

• VehicleInfo
• null

Vehicle category of the offer. category is the provider's own wording.

categorystring | nullnullable

Provider's vehicle category, free text, not normalised.

Example: AC SUV Large

modelstring | nullnullable

Example model, "or similar".

Example: Ertiga or similar

image_urlstring | nullnullable

Picture of the category.

Example: https://images.example.com/vehicles/ac-suv-large.png

max_passengersinteger | nullnullable

Seats.

Example: 6

max_bagsinteger | nullnullable

Suitcases.

Example: 2

duration_minutesinteger | nullnullable

Estimated ride time, when known.

Example: 25

distance_metersinteger | nullnullable

Route distance, when known.

Example: 148000

cancellation_summarystring | nullnullable

Cancellation terms in words, when known.

Example: 100% refund if cancelled at least 24h before pickup

flight_info_requiredboolean

true: flight details are required at book.

Default value: false

Example: false

legstring | nullnullable

Point-to-point and hourly: outbound, return (of a round trip searched as two legs) or round_trip (a round trip sold as one leg). null for airport offers.

Possible values: [outbound, return, round_trip]

Example: outbound

pickup_datetimestring | nullnullable

Pickup of this leg, local, YYYY-MM-DDTHH:MM. null for airport offers.

Example: 2026-11-27T09:00

pricing_modelstring

fixed_route: price for the route. hourly_package: hours (and km) included. outstation_package: multi-day or long-distance package with a kilometre allowance, extra km charged.

Possible values: [fixed_route, hourly_package, outstation_package]

Default value: fixed_route

Example: fixed_route

package object

What the package includes (hourly and package offers).

anyOf

• PackageInfo
• null

What an hourly or rental package includes.

hours_includednumber | nullnullable

Hours included.

Example: 4

km_includednumber | nullnullable

Kilometres included.

Example: 40

daysinteger | nullnullable

Days included (multi-day round trips).

Example: 3

codestring | nullnullable

Provider package code.

Example: oneWay

labelstring | nullnullable

Provider package label, for example Local (8hr/80 km).

Example: Outstation (150 km)

extra_charges object

Charges payable beyond the package.

anyOf

• ExtraCharges
• null

Charges payable beyond the package.

extra_km_rate object

Per extra kilometre.

anyOf

• Money
• null

An amount in the requested currency.

amountnumberrequired

Amount.

Example: 18

currencystringrequired

ISO 4217 currency: the requested currency.

Example: INR

extra_hour_rate object

Per extra hour.

anyOf

• Money
• null

An amount in the requested currency.

amountnumberrequired

Amount.

Example: 18

currencystringrequired

ISO 4217 currency: the requested currency.

Example: INR

night_charge object

Night charge.

anyOf

• Money
• null

An amount in the requested currency.

amountnumberrequired

Amount.

Example: 18

currencystringrequired

ISO 4217 currency: the requested currency.

Example: INR

driver_allowance object

Driver allowance.

anyOf

• Money
• null

An amount in the requested currency.

amountnumberrequired

Amount.

Example: 18

currencystringrequired

ISO 4217 currency: the requested currency.

Example: INR

inclusions object

What the price includes or excludes.

anyOf

• Inclusions
• null

What the price includes or excludes.

tollsboolean | nullnullable

Tolls included.

Example: true

state_taxboolean | nullnullable

State taxes included.

Example: true

parkingboolean | nullnullable

Parking included.

Example: false

driver_allowanceboolean | nullnullable

Driver allowance included.

Example: true

gratuityboolean | nullnullable

Gratuity included.

Example: false

includedstring[]

Included items, provider wording.

Example: ["Fuel Charges","Driver Allowance","Toll / State tax","GST (5%)"]

excludedstring[]

Excluded items, provider wording.

Example: ["Pay INR 18/km after 150 km","Multiple pickups/drops","Airport Entry/Parking"]

cancellation object

Cancellation terms. null for airport offers today: use cancellation_summary.

anyOf

• CancellationInfo
• null

Cancellation terms of the offer.

free_untilstring | nullnullable

Free cancellation until this pickup-local time, YYYY-MM-DDTHH:MM:SS, when known.

Example: 2026-11-26T10:30:00

free_cancellation_hoursnumber | nullnullable

Free cancellation up to this many hours before pickup.

Example: 6

rules object[]

Refund steps.

Array [

hours_before_pickupnumberrequired

Hours before pickup.

Example: 4

refund_percentnumberrequired

Refund in percent of the price.

Example: 100

]

policy_textstring | nullnullable

Policy in words.

Example: Free cancellation until 6h before pickup; later: INR 500 or 20% of the booking amount, whichever is less

included_waiting_minutesinteger | nullnullable

Waiting time included at pickup, when known.

Example: 30

]

errors object[]

Providers that failed or were skipped. May be non-empty even when offers are returned.

Array [

providerstringrequired

Provider.

Example: provider_c

codestringrequired

provider_not_enabled, mode_not_supported, city_not_mapped, lead_time_too_short, timeout, provider_rejected, provider_error or search_error. New codes may be added.

Example: provider_error

messagestringrequired

Explanation. Do not parse.

Example: Provider search failed

raw object | null

Detail: only leg, direction, transfer_type, timeout_seconds or min_lead_hours, when relevant.

property name*anynullable

Detail: only leg, direction, transfer_type, timeout_seconds or min_lead_hours, when relevant.

Example: {"leg":"outbound"}

]

meta object

Search summary: providers considered, legs or directions, offer count, sort order, currency and skipped_providers (always an object).

providersstring[]required

Providers considered.

Example: ["provider_a","provider_b","provider_c","provider_d"]

offer_countintegerrequired

Number of offers.

Example: 39

sortstringrequired

Sort order applied: price_asc.

Example: price_asc

currenciesstring[]required

The requested currency (empty when there are no offers).

Example: ["INR"]

directionsstring[]

Airport: legs searched (arrival, departure).

Example: ["arrival"]

legsstring[]

Point-to-point and hourly: legs searched.

Example: ["outbound"]

searches object[]

Point-to-point and hourly: provider and leg pairs actually searched.

Array [

providerstring

Example: healthy

legstring

Example: healthy

]

skipped_providers object

Always present ({} when empty). Providers that returned no offers for a non-error reason: provider_not_enabled, no_availability (searched, no product for this route and date), or a short text when the provider cannot serve the request.

property name*string

Example: healthy

trip_typestring

Point-to-point: one_way or round_trip.

Example: one_way

hoursinteger

Hourly: requested hours.

Example: 4

property name*any

Search summary: providers considered, legs or directions, offer count, sort order, currency and skipped_providers (always an object).

Example: {"providers":["provider_a","provider_b","provider_c","provider_d"],"directions":["arrival"],"skipped_providers":{},"offer_count":39,"sort":"price_asc","currencies":["INR"]}

TransferSearchResponse

{
  "request_id": "3e51940a-7b52-5ffe-a1c2-f7604038365d",
  "transfer_type": "airport",
  "offers": [
    {
      "provider": "provider_d",
      "transfer_type": "airport",
      "direction": "arrival",
      "offer_id": "1421a5071cc20000",
      "rate_key": "7",
      "offer_token": "ot1.gAAAAAB...opaque-offer-token...(about 1 kB; trimmed in this example)",
      "price": {
        "total": 1317,
        "currency": "INR",
        "taxes_included": true
      },
      "vehicle": {
        "category": "AC SUV Large",
        "model": "Ertiga or similar",
        "image_url": "https://images.example.com/vehicles/ac-suv-large.png",
        "max_passengers": 6,
        "max_bags": 2
      },
      "duration_minutes": null,
      "distance_meters": null,
      "cancellation_summary": null,
      "flight_info_required": false,
      "leg": null,
      "pickup_datetime": null,
      "pricing_model": "fixed_route",
      "package": null,
      "extra_charges": null,
      "inclusions": null,
      "cancellation": null,
      "included_waiting_minutes": null
    },
    {
      "provider": "provider_c",
      "transfer_type": "airport",
      "direction": "arrival",
      "offer_id": "9f0f189773d3b1c7",
      "rate_key": "F6879023",
      "offer_token": "ot1.gAAAAAB...opaque-offer-token...(about 1 kB; trimmed in this example)",
      "price": {
        "total": 1462.33,
        "currency": "INR",
        "taxes_included": true
      },
      "vehicle": {
        "category": "Sedan Hyundai Xcent or Similar 2018",
        "model": "Sedan Hyundai Xcent or Similar 2018",
        "image_url": "https://images.example.com/vehicles/sedan-hyundai-xcent-or-similar-2018.png",
        "max_passengers": 4,
        "max_bags": 3
      },
      "duration_minutes": 25,
      "distance_meters": null,
      "cancellation_summary": null,
      "flight_info_required": false,
      "leg": null,
      "pickup_datetime": null,
      "pricing_model": "fixed_route",
      "package": null,
      "extra_charges": null,
      "inclusions": null,
      "cancellation": null,
      "included_waiting_minutes": null
    },
    {
      "provider": "provider_a",
      "transfer_type": "airport",
      "direction": "arrival",
      "offer_id": "0f48d65d40e92602",
      "rate_key": "d320deaaed65343ed2a5b8fac337a7dd",
      "offer_token": "ot1.gAAAAAB...opaque-offer-token...(about 1 kB; trimmed in this example)",
      "price": {
        "total": 2508.37,
        "currency": "INR",
        "taxes_included": true
      },
      "vehicle": {
        "category": "Sedan",
        "model": "Corolla",
        "image_url": "https://images.example.com/vehicles/sedan.png",
        "max_passengers": 3,
        "max_bags": 3
      },
      "duration_minutes": 45,
      "distance_meters": null,
      "cancellation_summary": "100% refund if cancelled at least 24h before pickup",
      "flight_info_required": true,
      "leg": null,
      "pickup_datetime": null,
      "pricing_model": "fixed_route",
      "package": null,
      "extra_charges": null,
      "inclusions": null,
      "cancellation": null,
      "included_waiting_minutes": null
    },
    {
      "provider": "provider_b",
      "transfer_type": "airport",
      "direction": "arrival",
      "offer_id": "7f85ef6fe033b526",
      "rate_key": "1902",
      "offer_token": "ot1.gAAAAAB...opaque-offer-token...(about 1 kB; trimmed in this example)",
      "price": {
        "total": 16104.46,
        "currency": "INR",
        "taxes_included": true
      },
      "vehicle": {
        "category": "economy",
        "model": "Toyota Prius",
        "image_url": "https://images.example.com/vehicles/economy.png",
        "max_passengers": 4,
        "max_bags": 3
      },
      "duration_minutes": null,
      "distance_meters": null,
      "cancellation_summary": null,
      "flight_info_required": false,
      "leg": null,
      "pickup_datetime": null,
      "pricing_model": "fixed_route",
      "package": null,
      "extra_charges": null,
      "inclusions": null,
      "cancellation": null,
      "included_waiting_minutes": null
    }
  ],
  "errors": [
    {
      "provider": "provider_c",
      "code": "provider_error",
      "message": "Provider search failed",
      "raw": {
        "leg": "outbound"
      }
    }
  ],
  "meta": {
    "providers": [
      "provider_a",
      "provider_b",
      "provider_c",
      "provider_d"
    ],
    "directions": [
      "arrival"
    ],
    "skipped_providers": {},
    "offer_count": 39,
    "sort": "price_asc",
    "currencies": [
      "INR"
    ]
  }
}