DMS hosted API endpoint for receiving Karhoo trip bookings

This endpoint must be hosted within the Dispatch Managment System's platform to listen for new Karhoo Bookings in the described format.

Body Params

request body

string
required

Karhoos unqiue reference for a trip

string

Trip Reference Id provided by Karhoo Demand Partners

string

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

int64

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

external_info
object
required
origin
object
required
destination
object
required
string

Passenger entered notes for the trip

number

number of passengers

passengers
array of objects

passengers for the trip, this is optional

passengers
quote
object
string
length ≤ 15

the train number

string

the flight number

meta
object

Additional meta data for the trip

Headers
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

Language
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json