DMS Hosted API endpoint to respond to Karhoo Trip Update requests to your DMS platform.

put

https://rest.sandbox.karhoo.com/v1/supply/dispatch-system/trip

This endpoint must be hosted within the DMS platform to listen for trip detail requests in the described format.

Query Params

trip_id

string

required

The Karhoo trip id

external_trip_id

string

required

DMS trip id

Body Params

request body

trip_id

string

Karhoo's unqiue reference for a trip

partner_trip_id

string

Trip Reference Id provided by Karhoo Demand Partners

external_info

object

date_scheduled

string

Date should be specified in ISO 8601 Date Time format with the correct timezone for the origin, leave empty for ASAP booking

date_scheduled_utc

int64

UNIX Timestamp for scheduled pickup time, Represents seconds of UTC time since Unix epoch

origin

object

destination

object

state

object

Information about the trup state

vehicle

object

comment

string

Passenger entered notes for the trip

passenger_count

number

number of passengers

passengers

array of objects

passengers for the trip, this is optional

passengers

fare

object

train_number

string

length ≤ 15

the train number

flight_number

string

the flight number

quote

object

Headers

x-karhoo-request-signature

string

required

HMAC Hash of the your shared secret and the request payload. Use this to validate all requests from Karhoo

Responses

401

Unauthorized. Invalid credentials provided

403

Forbidden. The credentials provided do not have sufficient authority for this request

200Success response

400Invalid input