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

Welcome to the Karhoo API

Karhoo API Explorer

5 Minutes to Book a Trip

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

Authentication API 1.0

Auth
Health Check
- Check Servicesget

Identity API 1.0

OAuth 2.0
Token exchange
- Authenticating with third-party tokenspost

Services API 2.0

Services
- Retrieve Services Listget
- Request Servicespost
Healthcheck
- Check Servicesget

Quotes API 2.0

Quotes
- Request Quotespost
- Retrieve Quote Listget
Coverage
- Check Coverageget
Healthcheck
- Check Servicesget

Bookings API 1.0

Bookings
Healthcheck
- Check Servicesget

Fares API 1.0

final-fare
- Get final fare from trip idget
supplier-details
- Get supplier details related to tripget
documents
- Get trip document PDFget

Webhooks API 1.0

Webhooks

Network SDK

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
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
DMS Trip document push to Karhoopost
[Push] Trip Status
[Push] Trip Document
[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

Fleet External Accounts
- List fleet's external accountsget
- Create a new fleet external accountpost

Operations API 1.0

trips
- Provides an API for triggering a new resync with the DMSpost
- Add review for existing trippost
quotes
- Get raw dms payloadsget

Payments API 3.0

Loyalty
- Loyalty points user's balanceget
- Loyalty points conversion ratesget

Connect API 1.0

Order
- Create a order for delivery (with callbacks)put

Support API 1.0

SupportTickets

Partners API 1.0

Dispatch Partners

Powered by

iOS implementation

iOS

iOS Additional Feedback Screen

1242 — iOS Additional Feedback Screen

iOS example

Builder variables

Variable	Description

Table of Contents