Skip to content

Suggest pickup time

POST/quotes/suggest-pickup-time

Auth: X-API-Key headerhttps://warpdrive.staging.transferz.com/partners

Suggests a pickup time based on flight arrival or departure to be used in a subsequent quote request

Suggests when the traveller should be picked up, based on a flight's arrival or departure time and the route. For a departure it adds the drive time and a buffer for check-in and security; for an arrival it adds time to collect luggage. Use the suggested time as pickupDateTime in Request quotes.

Hotel to the airport

For a departing flight the origin is the address and the destination the airport; directionality in the response is DEPARTURE.

Guide: Suggest a pickup time

Headers

  • X-Request-IDstring

    The optional (ideally unique) request identifier used for later analysis or diagnostics

Request body

application/json · required

  • originobjectrequired
  • destinationobjectrequired
  • departureOrArrivalTimestring · date-timerequired

    The flight's departure or arrival time, local to the airport.

  • travelTypeenum

    Domestic or international, which changes the airport buffer.

    DOMESTIC
    A domestic flight.
    INTERNATIONAL
    An international flight.
  • onlyCarryOnLuggageboolean

    True when the traveller has no checked luggage.

  • roundToNearestMinutesinteger · int32

    Round the suggestion to this many minutes, for example 15.

  • flightNumberstring

    The flight number, if known.

Responses

OK

  • directionalityenum
    DEPARTURE
    The traveller is going to the airport for a departing flight.
    ARRIVAL
    The traveller is picked up after an arriving flight.
  • suggestedPickupTimestring · date-time

    Suggested pickup time, local to the pickup location.

  • distanceInMetersinteger · int32
  • durationInMinutesinteger · int32
  • bufferTimeinteger · int32

    Minutes of buffer included for the airport.

Errors this endpoint can return

  • 400, failedNO_HUB_SELECTED

    When: Neither location is a hub.

    What to do: Make the origin or the destination a hub, for example {"iataCode":"AMS"}.

  • 400, failedUNKNOWN

    When: The route could not be determined, for example because a location was not found.

    What to do: For 400, read message and correct the request. For 500, retry once; if it persists, contact Transferz support with the X-Request-ID you sent.