JUMP TOWelcome to the Karhoo APIKarhoo API Explorer5 Minutes to Book a TripYour journey starts herePlan a trippostRetrieve quotesgetBook a trippostReceive confirmationAuthentication API 1.0AuthGet an Access TokenpostRefresh Access TokenpostRevoke Refresh TokendeleteHealth CheckCheck ServicesgetIdentity API 1.0OAuth 2.0Authorize endpointgetToken endpointpostGetting user detailsgetRevoking issued tokenspostToken exchangeAuthenticating with third-party tokenspostServices API 2.0ServicesRetrieve Services ListgetRequest ServicespostHealthcheckCheck ServicesgetQuotes API 2.0QuotesRequest QuotespostRetrieve Quote ListgetVerify quote price with DMS before bookinggetCoverageCheck CoveragegetHealthcheckCheck ServicesgetBookings API 1.0BookingsBook a TrippostBook a Trip only if the preauthorisation of the payment_nonce is successfulpostGet Booking DetailsgetCancel a BookingpostRetrieve the estimated cancellation feegetGet Booking HistorygetGet Booking StatusgetGet Position of a TripgetSearch Booking HistorypostGet Trips for an OrganisationgetGet Trips for a FleetgetFollow a BookinggetCancel a Booking given a follow linkpostGet cancellation fee for a Booking given a follow codegetHealthcheckCheck ServicesgetFares API 1.0final-fareGet final fare from trip idgetsupplier-detailsGet supplier details related to tripgetdocumentsGet trip document PDFgetWebhooks API 1.0WebhooksRegister webhook endpointpostReturns active subscriptions for the usergetRemoves active subscriptions or delete by ID.deleteNetwork SDKAuth Servicelogin (token)revokeAddress ServiceplaceSearchlocationInforeverseGeocodeAddress object schemasQuotes ServicequotesQuotes object schemasTrip ServicebookcancelsearchtrackTripstatusTrip object schemasDriver Tracking ServicetrackDriverDriver Tracking object schemasUI SDKCustom stylingInjectable componentsDeeplinkAddress screeniOS implementationAndroid implementationBooking screeniOS implementationAndroid implementationTrip screeniOS implementationAndroid implementationRides screeniOS implementationAndroid implementationRide Details screeniOS implementationAndroid implementationAdditional Feedback screeniOS implementationAndroid implementationSupply API 1.0[Push] AvailabilityStream fleet wide vehicle availability to KarhoopostDMS Trip Status Push to KarhoopostDMS Trip document push to Karhoopost[Push] Trip Status[Push] Trip Document[DMS Endpoint] Receive New TripsDMS hosted API endpoint for receiving Karhoo trip bookingspost[DMS Endpoint] Provide Trip DetailsDMS Hosted endpoint to respond to Karhoo Trip Detail requestsget[DMS Endpoint] Cancel TripDMS Hosted endpoint to respond to Karhoo Trip Cancellation requestsdelete[DMS Endpoint] Update TripDMS Hosted API endpoint to respond to Karhoo Trip Update requests to your DMS platform.put[DMS Endpoint] Quote RequestDMS hosted API endpoint for responding to quote requestspost[DMS Endpoint] ETA RequestDMS hosted API endpoint for responding to ETA requestspost[DMS Endpoint] Availability RequestKarhoo Availability Request to DMSpostHealthcheckHealth check endpointgetLoyalty APILoyaltyGet loyalty exchange ratesgetGet user loyalty points balancegetBurn loyalty pointspostRefund loyalty pointspostHealthcheckCheck the health of your APIgetOnboarding APIFleet External AccountsList fleet's external accountsgetCreate a new fleet external accountpostOperations API 1.0tripsAdd review for existing trippostquotesGet raw dms payloadsgetPayments API 3.0LoyaltyLoyalty points user's balancegetLoyalty points conversion ratesgetConnect API 1.0OrderCreate a order for delivery (with callbacks)putSupport API 1.0SupportTicketsList support ticketsgetGet a support ticket by idgetAdd comment to a support ticket (reply to ticket)postCreate a trip support ticket for demand partner trip IDpostList support tickets for the tripgetCreate a trip support ticketpostUpload a Zendesk attachmentpostPartners API 1.0Dispatch PartnersDiscovers supply partners registered within given DMSgetImports the DMS-registered supply partnerpostManages imported DMS-registered supply partnerputDisables the DMS-registered supply partnerdeleteiOS implementationiOS iOS Additional Feedback Screen iOS Additional Feedback Screen iOS example Builder variables VariableDescription
