DMS hosted API endpoint for receiving Karhoo trip bookings

post

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

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

request body

trip_id

string

required

Karhoos unqiue reference for a trip

partner_trip_id

string

Trip Reference Id provided by Karhoo Demand Partners

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

external_info

object

required

origin

object

required

destination

object

required

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

quote

object

train_number

string

length ≤ 15

the train number

flight_number

string

the flight number

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