Trip object schemas

TripBooking

Property

Type

Required

Description

quoteId

String

userInto

UserInfo

flightNumber

String

TripSearch

Property

Type

Required

Description

tripStates

TripState

tripType

TripType

paginationRowCount

Int

paginationOffset

Int

TripType

Property

Type

Required

Description

asap

trips booked for as soon as possible

prebook

trips booked for a specified date

both

asap & prebook

TripInfo

Property

Type

Required

Description

tripId

String

displayId

String

state

TripState

vehicle

Vehicle

fleetInfo

FleetInfo

fare

Fare

quote

TripQuote

flightNumber

String

origin

TripLocationDetails

destination

TripLocationDetails

dateScheduled

Date

meetingPoint

MeetingPoint

TripState

Property

Type

Required

Description

requested

The trip is matching to the most efficient available driver (By Dispatch).

noDriversAvailable

The trip was unfulfilled because no driver was available.

confirmed

The trip has been accepted by Dispatch.

driverEnRoute

A driver is “en route” to the origin location. This state can occur multiple times in case of a driver re-assignment

arrived

The driver has arrived. This state might be skipped in some cases.

passengerOnBoard

Passenger is in the vehicle and the ride has “started”

completed

The trip has been completed.

bookerCancelled

The trip has been cancelled by the rider.

driverCancelled

The trip has been cancelled by the dispatch/ driver.

karhooCancelled

The trip has been cancelled by Karhoo.

failed

The trip booking failed

unknown

The trip state is unknown

Vehicle

Property

Type

Required

Description

vehicleClass

String

vehicleLicensePlate

String

description

String

driver

Driver

FleetInfo

fleetId

String

name

String

logoUrl

String

description

String

phoneNumber

String

termsConditionsUrl

String

email

String

Fare

Property

Type

Required

Description

total

Int

denominateTotal

Double

currency

String

gratuityPercent

Int

breakdown

FareComponent

FareComponent

Property

Type

Required

Description

value

Int

name

String

description

String

TripQuote

Property

Type

Required

Description

total

Int

currency

String

gratuityPercent

Int

breakdown

FareComponent

denominateTotal

Double

qtaHighMinutes

Int

qtaLowMinutes

Int

type

QuoteType

vehicleClass

String

vehicleAttributes

VehicleAttributes

VehicleAttributes

Property

Type

Required

Description

childSeat

Bool

electric

Bool

hybrid

Bool

luggageCapacity

Int

passengerCapacity

Int

TripLocationDetails

Property

Type

Required

Description

displayAddress

String

placeId

String

position

Position

timeZoneIdentifier

String

Position

Property

Type

Required

Description

latitude

Double

longitude

Double

TripLocationDetails

Property

Type

Required

Description

displayAddress

String

placeId

String

position

Position

timeZoneIdentifier

String

MeetingPoint

Property

Type

Required

Description

position

Position

instructions

String

tyoe

MeetingPointType

MeetingPointType

Property

Type

Required

Description

defaultType

pickup

dropOff

meetAndGreet

curbSide

standBy

notSet

Driver

Property

Type

Required

Description

firstName

String

lastName

String

phoneNumber

String

photoUrl

String

licenseNumber

String

CancelReason

Property

Type

Required

Description

askedByDriverToCancel

notNeededAnymore

cannotFindVehicle

driverIsLate

etaTooLong

driverDidntShowUp

otherUserReason