GET/api/partner/v1/bookings/{bookingId}/gps/mileage

Booking mileage

How far one rental drove.

The mileage of a single rental, over the booking's own window — what a mileage overage is computed from. Read it while the rental is still inside the position retention: once the raw fixes are purged the answer becomes 0.

Authorization

X-Api-Key header

Send your partner key on every request. The key is bound to exactly one owner account.

Path parameters

bookingIdstringpathrequired

Our booking id OR your own external booking id.

Response

200 · application/json

successbooleanrequired

dataobject

Distance driven over a window, summed from the vehicle's own fixes.

carIdstring

externalCarIdstringnullable

bookingIdstringnullable

Set on the booking-scoped read.

externalBookingIdstringnullable

fromUtcstring <date-time>

toUtcstring <date-time>

distanceMilesnumber

distanceKmnumber

positionCountinteger

Fixes the figure was summed from. 0 or 1 means no distance could be measured.

coveredFromUtcstring <date-time>nullable

First fix actually found in the window — null when the period holds none.

coveredToUtcstring <date-time>nullable

truncatedboolean

The window held more fixes than one request reads; the distance is then a lower bound.

errorstringnullable

Status codes

200The distance driven during the rental.

401Missing, unknown or revoked API key.

404The resource does not exist under this owner.