Request Services

post

https://rest.sandbox.karhoo.com/v2/services/

This endpoint will return a list of services offered in the chosen location. You can either request a trip for a future date-time or ASAP (by leaving the date-time blank).
The response will contain services list ID and empty services list. Retrieving available quotes may take some time and for this reason there is latency_budget parameter that allows to define how long it will take to retrieve valid quotes. The longer the budget the more accurate prices will be returned. If latency_budget is not provided, the response will contain services list ID and empty services list.
Please note that whilst the display_address field is marked optional, we strongly recommend providing this where possible to help ensure the best level of service.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request body

origin

object

required

destination

object

required

local_time_of_pickup

string

Date/time of the required pickup (in YYYY-MM-DDTHH:MM format). You can leave this empty for an immediate trip.

driving_distance_metres

uint32

Driving distance in metres between origin and destination.

driving_time_minutes

uint32

Driving time in minutes.

latency_budget

uint32

Time in milliseconds defining how long it will take to retrieve valid quotes.

seats

uint32

Minimum number of seats the vehicle should have available for passengers.

services_list_id

string

services

array of objects

Array of demanded services. Leave empty to get a list of all available services for the chosen route.

services

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

*/*

201The reqeust was successful. The response body will contain a service_id which should be used when calling the booking endpoint.

400Bad Request. The request was invalid.

401Unauthorized. The request requires user authentication (not logged in).

403Forbidden. The credentials provided do not have sufficient authority for this request. Please request access by emailing API Support.

404Not found. No availability in the requested area. There might not be any fleet coverage in the specified area. You can check the availability in the area by calling the quotes/coverage endpoint.

429Error. Too Many Requests. Exceeded the rate limit for requests.

500Internal server error. Something has gone wrong on the website's server, but the server could not be more specific on what the exact problem is.

502Bad Gateway. The server, which was acting as a gateway or proxy, received an invalid response from the upstream server.