Karhoo for Developers | Mobility Exchange API and SDK reference

  1. Getting started
  2. Quotes
  3. Bookings
  4. Trip updates
  5. Settlements
  6. Testing

Quote requests

Endpoint: POST https://supply-partner.com/quote

Quote requests fall in to one of two categories. those intended for a date in the future and those that require a ride ASAP (As soon as possible). We distinguish these two types of requests through the date_scheduled parameter. Any requests that includes a date_scheduled value is intended as a pre-book quote request. Otherwise it should be treated as an ASAP booking.

🚧

Don't support ASAP bookings?

If you do not support ASAP bookings (all booking must be pre-booked) then you should return a 400 response as described in the API documentation for any request that does not contain a date_scheduled value.

Quote Batching

While we prefer to make a single request for all fleets and vehicle types available, if needed Karhoo can request per fleet or vehicle type. In this scenario fleet_id and/or vehicle_type will be present in the request within the external_info object.

Quote batching is a platform configuration option that can be discussed more by contacting the Karhoo team.

Example

{
  "external_info": {
    "fleet_id": "f9dcd72d-640d-4124-ae0d-8f54262a152b",
    "vehicle_type": "R4"
  },
  "origin": {
    "position": {
      "latitude": 51.5086692,
      "longitude": -0.1375291
    },
    "address": {
      "display_address": "407 W 42nd St New York, NY, 10036",
      "building_number": "407",
      "street_name": "W 42nd St",
      "city": "New York",
      "region": "NY",
      "postal_code": "10036",
      "country_code": "US"
    }
  },
  "destination": {
    "position": {
      "latitude": 40.7587711,
      "longitude": -73.9952016
    },
    "address": {
      "display_address": "407 W 42nd St New York, NY, 10036",
      "building_number": "407",
      "street_name": "W 42nd St",
      "city": "New York",
      "region": "NY",
      "postal_code": "10036",
      "country_code": "US"
    }
  },
  "date_scheduled": "2016-04-21T21:57:48Z"
}

An example response to the above call with the total given in cents:

{
    "quotes": [
        {
            "external_info": {
                "vehicle_type": "R4"
            },
            "quote": {
                "currency": "USD",
                "total": 72660
            }
        }
    ]
}

Reference

Service

API reference

Errors reference

Quotes

[DMS Endpoint] Quote Request

Updated 5 months ago

Quotes


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.