VendorVehicleManagementApi
All URIs are relative to https://business.apis.kesk.app/v1
| Method | HTTP request | Description |
|---|---|---|
| assignVehicleToDriverPartner | POST /vendors/{vendor_id}/vehicle-management/assign-vehicle | Assigns an existing vehicle to the driver partner’s fleet. |
| createDriverPartnerVehicle | POST /vendors/{vendor_id}/vehicles | Registers a new vehicle to the driver partner’s fleet. |
| deleteDriverPartnerVehicle | DELETE /vendors/{vendor_id}/vehicles/{vehicle_id} | Removes a vehicle from the driver partner’s fleet permanently. |
| getDriverPartnerVehicle | GET /vendors/{vendor_id}/vehicles/{vehicle_id} | Retrieves detailed information for a specific vehicle in the fleet. |
| listDriverPartnerVehicles | GET /vendors/{vendor_id}/vehicles | Retrieves a paginated list of all vehicles in the driver partner’s fleet. |
| removeVehicleFromDriverPartner | DELETE /vendors/{vendor_id}/vehicles/{vehicle_id}/remove-assignment | Removes the association between a vehicle and the driver partner’s fleet. |
| updateDriverPartnerVehicle | PUT /vendors/{vendor_id}/vehicles/{vehicle_id} | Updates existing vehicle information in the fleet. |
assignVehicleToDriverPartner
MessageResponse assignVehicleToDriverPartner(vendor_id, AssignVehicleToVendorRequest)
Assigns an existing vehicle to the driver partner’s fleet.
Links a previously registered vehicle to the driver partner organization, making it available for driver assignments and operational use. Validates ownership and compliance before assignment.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | The unique identifier of the driver partner organization | [default to null] |
| AssignVehicleToVendorRequest | AssignVehicleToVendorRequest | Request containing the vehicle identifier to assign to the fleet |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
createDriverPartnerVehicle
VendorVehicleResponse createDriverPartnerVehicle(vendor_id, CreateVendorVehicleRequest)
Registers a new vehicle to the driver partner’s fleet.
Creates a vehicle record with registration details, specifications, and documentation. The vehicle undergoes validation and is added to the fleet inventory for subsequent driver assignment and operations.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | The unique identifier of the driver partner organization | [default to null] |
| CreateVendorVehicleRequest | CreateVendorVehicleRequest | Vehicle registration details including make, model, registration number, and documentation |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
deleteDriverPartnerVehicle
MessageResponse deleteDriverPartnerVehicle(vendor_id, vehicle_id)
Removes a vehicle from the driver partner’s fleet permanently.
Deletes the vehicle record from the fleet inventory. This operation removes all vehicle data and should only be performed when the vehicle is no longer associated with active operations or assignments.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | The unique identifier of the driver partner organization | [default to null] |
| vehicle_id | Long | The unique identifier of the vehicle to remove from the fleet | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getDriverPartnerVehicle
VendorVehicleResponse getDriverPartnerVehicle(vendor_id, vehicle_id)
Retrieves detailed information for a specific vehicle in the fleet.
Returns complete vehicle details including registration information, specifications, verification status, current driver assignment, and operational history for fleet management and compliance purposes.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | The unique identifier of the driver partner organization | [default to null] |
| vehicle_id | Long | The unique identifier of the vehicle to retrieve | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listDriverPartnerVehicles
PaginatedResponse_VendorVehicleResponse listDriverPartnerVehicles(vendor_id, per_page, page, search, vehicle_type_id, is_active, verified, driver_id)
Retrieves a paginated list of all vehicles in the driver partner’s fleet.
Returns fleet vehicles with support for filtering by vehicle type, active status, verification status, assigned driver, and general search criteria. Includes pagination for managing large fleets efficiently.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | The unique identifier of the driver partner organization | [default to null] |
| per_page | Integer | Number of vehicles to return per page (default: 10) | [optional] [default to null] |
| page | Integer | Page number for pagination (default: 1) | [optional] [default to null] |
| search | String | Search term for filtering vehicles by registration number, make, or model | [optional] [default to null] |
| vehicle_type_id | Long | Filter by specific vehicle type identifier | [optional] [default to null] |
| is_active | Boolean | Filter by vehicle active status | [optional] [default to null] |
| verified | Boolean | Filter by verification status | [optional] [default to null] |
| driver_id | Long | Filter by currently assigned driver identifier | [optional] [default to null] |
Return type
PaginatedResponse_VendorVehicleResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
removeVehicleFromDriverPartner
MessageResponse removeVehicleFromDriverPartner(vendor_id, vehicle_id)
Removes the association between a vehicle and the driver partner’s fleet.
Unlinks the vehicle from the driver partner organization without deleting the vehicle record. The vehicle becomes unassigned and unavailable for operations until reassigned to another partner.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | The unique identifier of the driver partner organization | [default to null] |
| vehicle_id | Long | The unique identifier of the vehicle to unassign from the fleet | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
updateDriverPartnerVehicle
VendorVehicleResponse updateDriverPartnerVehicle(vendor_id, vehicle_id, UpdateVendorVehicleRequest)
Updates existing vehicle information in the fleet.
Modifies vehicle details including registration information, specifications, status, and documentation. Supports partial updates while maintaining data integrity and compliance requirements for fleet operations.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | The unique identifier of the driver partner organization | [default to null] |
| vehicle_id | Long | The unique identifier of the vehicle to update | [default to null] |
| UpdateVendorVehicleRequest | UpdateVendorVehicleRequest | Updated vehicle information with fields to modify |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8