Skip to Content

DriverPartnerOrdersApi

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

MethodHTTP requestDescription
getDriverPartnerDriverOrderDetailsGET /vendors/{vendor_id}/drivers/{driver_id}/orders/{order_id}Get order details
getDriverPartnerDriverOrdersGET /vendors/{vendor_id}/drivers/{driver_id}/ordersList driver orders
updateDriverPartnerDriverOrderPUT /vendors/{vendor_id}/drivers/{driver_id}/orders/{order_id}Update order status

getDriverPartnerDriverOrderDetails

DriverOrderResponse getDriverPartnerDriverOrderDetails(vendor_id, driver_id, order_id)

Get order details

Retrieves comprehensive details about a specific order including customer information, delivery address, items, and current status.

Parameters

NameTypeDescriptionNotes
vendor_idLongThe ID of the vendor organization[default to null]
driver_idLongThe ID of the driver viewing the order[default to null]
order_idLongThe ID of the order to retrieve[default to null]

Return type

DriverOrderResponse

Authorization

JwtAuthScheme

HTTP request headers

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

getDriverPartnerDriverOrders

PaginatedResponse_DriverOrderResponse getDriverPartnerDriverOrders(vendor_id, driver_id, status, type, page, per_page)

List driver orders

Retrieves all orders assigned to the driver with filtering options for status and type. Supports pagination and order history viewing.

Parameters

NameTypeDescriptionNotes
vendor_idLongThe ID of the vendor organization[default to null]
driver_idLongThe ID of the driver whose orders to list[default to null]
statusOrderStatusFilter by order status[optional] [default to null] [enum: Pending, Accepted, Preparing, Ready, Enroute, Delivered, Completed, Failed, Cancelled]
typeOrderListTypeFilter by order list type (history/assigned)[optional] [default to null] [enum: history, assigned]
pageIntegerPage number for pagination[optional] [default to null]
per_pageIntegerNumber of items per page[optional] [default to null]

Return type

PaginatedResponse_DriverOrderResponse

Authorization

JwtAuthScheme

HTTP request headers

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

updateDriverPartnerDriverOrder

DriverOrderResponse updateDriverPartnerDriverOrder(vendor_id, driver_id, order_id, delivery_confirmation_photo, status, reason)

Update order status

Updates the order status during delivery or service completion. Supports status transitions and delivery confirmation photo uploads.

Parameters

NameTypeDescriptionNotes
vendor_idLongThe ID of the vendor organization[default to null]
driver_idLongThe ID of the driver updating the order[default to null]
order_idLongThe ID of the order to update[default to null]
delivery_confirmation_photoList[default to null]
statusString[optional] [default to null]
reasonString[optional] [default to null]

Return type

DriverOrderResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json; charset=utf-8