TaxiApi
All URIs are relative to https://business.apis.kesk.app/v1
| Method | HTTP request | Description |
|---|---|---|
| acceptDriverPartnerTaxiDriverAssignment | POST /vendors/{vendor_id}/drivers/{driver_id}/taxi/accept-assignment | Accept ride assignment |
| bookTaxiOrder | POST /taxi/book | Book a new taxi ride. |
| cancelTaxiOrder | POST /taxi/cancel-order/{order_id} | Cancel an active or pending taxi booking. |
| checkTaxiLocationAvailability | POST /taxi/location-available | Check if taxi service is available for given locations. |
| getCurrentRateableTaxiOrder | GET /taxi/current-rateable | Get recently completed ride pending rating. |
| getCurrentTaxiOrder | GET /taxi/current | Get details of the user’s active taxi ride. |
| getNearbyTaxis | GET /taxi/nearby | Find nearby available taxis |
| getTaxiDriverInfo | GET /taxi/driver-info/{driver_id} | Retrieve detailed information about a taxi driver. |
| getTaxiLocationHistory | GET /taxi/location-history | Retrieve user’s previous taxi pickup and dropoff locations. |
| possibleDriverEta | POST /taxi/possible_driver_eta | Calculate estimated driver arrival time |
| rejectDriverPartnerTaxiDriverAssignment | POST /vendors/{vendor_id}/drivers/{driver_id}/taxi/reject-assignment | Reject ride assignment |
acceptDriverPartnerTaxiDriverAssignment
TaxiDriverOrderOperationResponse acceptDriverPartnerTaxiDriverAssignment(vendor_id, driver_id, TaxiDriverAcceptAssignmentInput)
Accept ride assignment
Confirms acceptance of an assigned ride request. The driver will be notified with pickup details and customer information.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | The ID of the vendor organization | [default to null] |
| driver_id | Long | The ID of the driver accepting the assignment | [default to null] |
| TaxiDriverAcceptAssignmentInput | TaxiDriverAcceptAssignmentInput | Acceptance confirmation details |
Return type
TaxiDriverOrderOperationResponse
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
bookTaxiOrder
TaxiOrderActionResponse bookTaxiOrder(BookTaxiOrderRequest)
Book a new taxi ride.
Creates a taxi booking request with pickup and dropoff locations, validates the request, and initiates driver matching. Returns booking confirmation with order details and estimated arrival time.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| BookTaxiOrderRequest | BookTaxiOrderRequest | Booking request with locations and ride preferences |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
cancelTaxiOrder
TaxiOrderActionResponse cancelTaxiOrder(order_id)
Cancel an active or pending taxi booking.
Cancels a taxi order that is pending or en route. Notifies the driver if already assigned and processes any applicable cancellation fees based on the cancellation policy.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| order_id | Long | Order ID to cancel | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
checkTaxiLocationAvailability
TaxiOrderActionResponse checkTaxiLocationAvailability(LocationAvailableRequest)
Check if taxi service is available for given locations.
Verifies whether pickup and dropoff locations are within the service area and if drivers are available. Returns service availability status and estimated pricing.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| LocationAvailableRequest | LocationAvailableRequest | Location availability request with pickup and dropoff coordinates |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
getCurrentRateableTaxiOrder
OrderDetailsResponse getCurrentRateableTaxiOrder()
Get recently completed ride pending rating.
Retrieves the most recent completed taxi ride that hasn’t been rated yet, allowing the user to provide feedback and rating for the driver and service.
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getCurrentTaxiOrder
OrderDetailsResponse getCurrentTaxiOrder()
Get details of the user’s active taxi ride.
Retrieves information about the current ongoing taxi ride including driver details, current location, estimated arrival time, and ride status. Returns null if no active ride.
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getNearbyTaxis
PaginatedResponse_NearbyTaxiVehicleResponse getNearbyTaxis(min_lat, min_lon, max_lat, max_lon, page, per_page)
Find nearby available taxis
Returns all available taxi vehicles within a specified geographic bounding box, including their real-time location, rotation angle, and vehicle type information. Used for displaying taxis on maps and initiating booking requests.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| min_lat | Double | Minimum latitude of the search area (must be between -90.0 and 90.0) | [default to null] |
| min_lon | Double | Minimum longitude of the search area (must be between -180.0 and 180.0) | [default to null] |
| max_lat | Double | Maximum latitude of the search area (must be between -90.0 and 90.0) | [default to null] |
| max_lon | Double | Maximum longitude of the search area (must be between -180.0 and 180.0) | [default to null] |
| page | Integer | Page number for pagination (default: 1) | [optional] [default to null] |
| per_page | Integer | Items per page for pagination (default: 20) | [optional] [default to null] |
Return type
PaginatedResponse_NearbyTaxiVehicleResponse
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getTaxiDriverInfo
TaxiDriverInfoResponse getTaxiDriverInfo(driver_id)
Retrieve detailed information about a taxi driver.
Gets comprehensive driver profile including name, photo, vehicle details, ratings, and contact information for the specified driver.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| driver_id | Long | Driver ID to retrieve information for | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getTaxiLocationHistory
PaginatedResponse_PickupDropoff getTaxiLocationHistory(page, per_page)
Retrieve user’s previous taxi pickup and dropoff locations.
Returns a history of saved locations from past taxi rides to enable quick booking with frequently used addresses. Helps users avoid re-entering location details.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| page | Integer | Page number for pagination (default: 1) | [optional] [default to null] |
| per_page | Integer | Items per page for pagination (default: 20) | [optional] [default to null] |
Return type
PaginatedResponse_PickupDropoff
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
possibleDriverEta
PossibleDriverEtaResponse possibleDriverEta(PossibleDriverEtaRequest)
Calculate estimated driver arrival time
Computes the estimated time of arrival for the nearest available driver based on the provided pickup coordinates. Searches for active drivers within a configurable radius and returns the shortest ETA in minutes, or a message if no drivers are found.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| PossibleDriverEtaRequest | PossibleDriverEtaRequest | ETA request containing pickup coordinates and optional vehicle type filter |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
rejectDriverPartnerTaxiDriverAssignment
TaxiDriverOrderOperationResponse rejectDriverPartnerTaxiDriverAssignment(vendor_id, driver_id, TaxiDriverRejectAssignmentInput)
Reject ride assignment
Allows taxi drivers to decline an assigned ride request. The ride will be reassigned to another available driver in the area.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | The ID of the vendor organization | [default to null] |
| driver_id | Long | The ID of the driver rejecting the assignment | [default to null] |
| TaxiDriverRejectAssignmentInput | TaxiDriverRejectAssignmentInput | Rejection details including reason |
Return type
TaxiDriverOrderOperationResponse
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8