VendorFleetManagementApi

All URIs are relative to https://business.apis.kesk.app/v1

Method	HTTP request	Description
assignUserToDriverPartnerFleet	POST /vendors/`{vendor_id}`/fleets/`{fleet_id}`/assign-user	Assign a user to a fleet
assignVehicleToDriverPartnerFleet	POST /vendors/`{vendor_id}`/fleets/`{fleet_id}`/assign-vehicle	Assign a vehicle to a fleet
createDriverPartnerFleet	POST /vendors/`{vendor_id}`/fleets	Create a new driver partner fleet
deleteDriverPartnerFleet	DELETE /vendors/`{vendor_id}`/fleets/`{fleet_id}`	Delete a driver partner fleet
getDriverPartnerFleet	GET /vendors/`{vendor_id}`/fleets/`{fleet_id}`	Get a specific driver partner fleet
listDriverPartnerFleets	GET /vendors/`{vendor_id}`/fleets	List all fleets
removeUserFromDriverPartnerFleet	DELETE /vendors/`{vendor_id}`/fleets/`{fleet_id}`/remove-user/`{user_id}`	Remove a user from a fleet
removeVehicleFromDriverPartnerFleet	DELETE /vendors/`{vendor_id}`/fleets/`{fleet_id}`/remove-vehicle/`{vehicle_id}`	Remove a vehicle from a fleet
updateDriverPartnerFleet	PUT /vendors/`{vendor_id}`/fleets/`{fleet_id}`	Update a driver partner fleet

assignUserToDriverPartnerFleet

MessageResponse assignUserToDriverPartnerFleet(vendor_id, fleet_id, AssignUserToFleetRequest)

Assign a user to a fleet

Parameters

Name	Type	Description	Notes
vendor_id	Long	The ID of the driver partner organization	[default to null]
fleet_id	Long	The ID of the fleet to assign the user to	[default to null]
AssignUserToFleetRequest	AssignUserToFleetRequest	User assignment data containing the user ID to assign

Return type

MessageResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

assignVehicleToDriverPartnerFleet

MessageResponse assignVehicleToDriverPartnerFleet(vendor_id, fleet_id, AssignVehicleToFleetRequest)

Assign a vehicle to a fleet

Parameters

Name	Type	Description	Notes
vendor_id	Long	The ID of the driver partner organization	[default to null]
fleet_id	Long	The ID of the fleet to assign the vehicle to	[default to null]
AssignVehicleToFleetRequest	AssignVehicleToFleetRequest	Vehicle assignment data containing the vehicle ID to assign

Return type

MessageResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

createDriverPartnerFleet

DriverPartnerFleetResponse createDriverPartnerFleet(vendor_id, CreateDriverPartnerFleetRequest)

Create a new driver partner fleet

Parameters

Name	Type	Description	Notes
vendor_id	Long	The ID of the driver partner organization	[default to null]
CreateDriverPartnerFleetRequest	CreateDriverPartnerFleetRequest	Fleet creation data including name, description, and business ID

Return type

DriverPartnerFleetResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

deleteDriverPartnerFleet

MessageResponse deleteDriverPartnerFleet(vendor_id, fleet_id)

Delete a driver partner fleet

Parameters

Name	Type	Description	Notes
vendor_id	Long	The ID of the driver partner organization	[default to null]
fleet_id	Long	The ID of the fleet to delete	[default to null]

Return type

MessageResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

getDriverPartnerFleet

DriverPartnerFleetResponse getDriverPartnerFleet(vendor_id, fleet_id)

Get a specific driver partner fleet

Parameters

Name	Type	Description	Notes
vendor_id	Long	The ID of the driver partner organization	[default to null]
fleet_id	Long	The ID of the fleet to retrieve	[default to null]

Return type

DriverPartnerFleetResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

listDriverPartnerFleets

PaginatedResponse_DriverPartnerFleetResponse listDriverPartnerFleets(vendor_id, per_page, page, search, business_id)

List all fleets

Retrieves all fleets configured for the driver partner with filtering and search capabilities.

Parameters

Name	Type	Description	Notes
vendor_id	Long	The ID of the driver partner organization	[default to null]
per_page	Integer	Number of items per page	[optional] [default to null]
page	Integer	Page number for pagination	[optional] [default to null]
search	String	Search query for fleet name	[optional] [default to null]
business_id	Long	Filter by business ID	[optional] [default to null]

Return type

PaginatedResponse_DriverPartnerFleetResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

removeUserFromDriverPartnerFleet

MessageResponse removeUserFromDriverPartnerFleet(vendor_id, fleet_id, user_id)

Remove a user from a fleet

Parameters

Name	Type	Description	Notes
vendor_id	Long	The ID of the driver partner organization	[default to null]
fleet_id	Long	The ID of the fleet to remove the user from	[default to null]
user_id	Long	The ID of the user to remove from the fleet	[default to null]

Return type

MessageResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

removeVehicleFromDriverPartnerFleet

MessageResponse removeVehicleFromDriverPartnerFleet(vendor_id, fleet_id, vehicle_id)

Remove a vehicle from a fleet

Parameters

Name	Type	Description	Notes
vendor_id	Long	The ID of the driver partner organization	[default to null]
fleet_id	Long	The ID of the fleet to remove the vehicle from	[default to null]
vehicle_id	Long	The ID of the vehicle to remove from the fleet	[default to null]

Return type

MessageResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

updateDriverPartnerFleet

DriverPartnerFleetResponse updateDriverPartnerFleet(vendor_id, fleet_id, UpdateDriverPartnerFleetRequest)

Update a driver partner fleet

Parameters

Name	Type	Description	Notes
vendor_id	Long	The ID of the driver partner organization	[default to null]
fleet_id	Long	The ID of the fleet to update	[default to null]
UpdateDriverPartnerFleetRequest	UpdateDriverPartnerFleetRequest	Updated fleet data including name, description, and status

Return type

DriverPartnerFleetResponse

Authorization

JwtAuthScheme

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8