Jump to Content

Home Guides API Reference Changelog

Home API Reference Guides Changelog Karhoo.com Log In

API Reference

Home API Reference Guides Changelog Karhoo.com Log In

These docs are for v1.0. Click to read the latest docs for v2.0.

Welcome to the Karhoo API

Karhoo API Explorer

5 Minutes to Book a Trip

Your journey starts here
Plan a trippost
Request quotespost
Retrieve quotesget
Book a trippost
Receive confirmation

Authentication API 1.0

Auth
Health Check
- Check Servicesget

OAuth 2.0 API

OAuth 2.0
Token exchange
- Authenticating with third-party tokenspost

Quotes API 1.0

Quotes
Availability
- Check Availabilitypost
Healthcheck
- Check Servicesget

Bookings API 1.0

Bookings
Healthcheck
- Check Servicesget

Fares API 1.0

final-fare
- Get final fare from trip idget

Locations API 1.0

Addresses
Healthcheck
- Check Servicesget

Network SDK

User Service
Auth Service
- login (token)
- revoke
Address Service
Quotes Service
- quotes
- Quotes object schemas
Trip Service
Driver Tracking Service
- trackDriver
- Driver Tracking object schemas

UI SDK

Custom styling
Injectable components
Deeplink
Address screen
- iOS implementation
- Android implementation
Booking screen
- iOS implementation
- Android implementation
Flight Number screen
- iOS implementation
- Android implementation
Trip screen
- iOS implementation
- Android implementation
Rides screen
- iOS implementation
- Android implementation
Ride Details screen
- iOS implementation
- Android implementation
Additional Feedback screen
- iOS implementation
- Android implementation

Supply API 1.0

[Push] Availability
- Stream fleet wide vehicle availability to Karhoopost
DMS Trip Status Push to Karhoopost
[Push] Trip Status
[DMS Endpoint] Receive New Trips
- DMS hosted API endpoint for receiving Karhoo trip bookingspost
[DMS Endpoint] Provide Trip Details
- DMS Hosted endpoint to respond to Karhoo Trip Detail requestsget
[DMS Endpoint] Cancel Trip
- DMS Hosted endpoint to respond to Karhoo Trip Cancellation requestsdel
[DMS Endpoint] Update Trip
- DMS Hosted API endpoint to respond to Karhoo Trip Update requests to your DMS platform.put
[DMS Endpoint] Quote Request
- DMS hosted API endpoint for responding to quote requestspost
[DMS Endpoint] ETA Request
- DMS hosted API endpoint for responding to ETA requestspost
[DMS Endpoint] Availability Request
- Karhoo Availability Request to DMSpost
Healthcheck
- Health check endpointget

Loyalty API

Loyalty
Healthcheck
- Check the health of your APIget

Onboarding API 1.0

Vehicle classification
- Get available vehicle typesget
- Get available vehicle tagsget

Payments API 3.0

Payments
- Payment providers and loyalty programmesget
Loyalty
- Loyalty points user's balanceget
- Loyalty points conversion ratesget

Quotes API 2.0

Quotes
Healthcheck
- Check Servicesget

Support API 1.0

SupportTickets

Powered by

Android implementation

Android

Android Additional Feedback Screen

1080 — Android Additional Feedback Screen

Android example

Builder variables

Variable	Description

Updated over 6 years ago

Updated over 6 years ago

Table of Contents