OrdersApi
All URIs are relative to https://business.apis.kesk.app/v1
| Method | HTTP request | Description |
|---|---|---|
| appCreate | POST /orders | Create a new order with automatic type detection. |
| getOrderDetails | GET /orders/{id} | Get detailed information for a specific order. |
| getOrders | GET /orders | List orders with filtering and pagination. |
| processServiceOrder | POST /orders/service | Create a service booking order. |
| trackOrder | POST /track-order | Track an order by its tracking code. |
| updateOrder | PUT /orders/{id} | Update order status, payment, or assignment. |
appCreate
OrderResponse appCreate(CreateOrderInput, photo, photos)
Create a new order with automatic type detection.
Creates an order based on the provided type field: regular product orders, package delivery, or service bookings. Validates payment methods, checks wallet balance, and supports both single-vendor and multi-vendor orders. Requires payment method unless proof of payment is provided.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| CreateOrderInput | CreateOrderInput | Order creation details including items, addresses, and payment information | |
| photo | String | Optional payment proof photo (single) | [optional] [default to null] |
| photos | String | Optional payment proof photos (multiple) | [optional] [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
getOrderDetails
OrderResponse getOrderDetails(id)
Get detailed information for a specific order.
Retrieves comprehensive order details including items, vendor information, delivery address, driver details, payment status, and order history. Includes related entities and media URLs.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | Long | Order ID to retrieve | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getOrders
PaginatedResponse_OrderListItemResponse getOrders(driver_id, vendor_id, status, type, vendor_type_id, page, per_page)
List orders with filtering and pagination.
Retrieves a paginated list of orders for the authenticated user with optional filtering by status, vendor, driver, or order type. Supports filtering for history (completed orders) or assigned (active orders) through the type parameter.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| driver_id | Long | Filter orders by driver ID | [optional] [default to null] |
| vendor_id | Long | Filter orders by vendor ID | [optional] [default to null] |
| status | OrderStatus | Filter orders by status (pending, preparing, ready, enroute, delivered, failed, cancelled) | [optional] [default to null] [enum: Pending, Accepted, Preparing, Ready, Enroute, Delivered, Completed, Failed, Cancelled] |
| type | OrderListType | Filter by order list type (history for completed orders, assigned for active orders) | [optional] [default to null] [enum: history, assigned] |
| vendor_type_id | Long | Filter orders by vendor type | [optional] [default to null] |
| page | Integer | Page number for pagination (defaults to 1) | [optional] [default to null] |
| per_page | Integer | Number of items per page (defaults to 15) | [optional] [default to null] |
Return type
PaginatedResponse_OrderListItemResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
processServiceOrder
OrderResponse processServiceOrder(CreateOrderInput)
Create a service booking order.
Processes service orders for professional services like cleaning, repairs, or consultations. Validates service availability, payment method, and wallet balance before creating the order.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| CreateOrderInput | CreateOrderInput | Service order details including service ID, vendor, and payment method |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
trackOrder
TrackOrderResponse trackOrder(TrackOrderRequest)
Track an order by its tracking code.
Retrieves real-time order information including current status, estimated delivery time, driver location, vendor details, and order items. Uses the order’s unique tracking code for secure, shareable tracking without requiring authentication.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| TrackOrderRequest | TrackOrderRequest | Tracking request with order code |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
updateOrder
OrderResponse updateOrder(id, UpdateOrderInput)
Update order status, payment, or assignment.
Allows updating order status, payment method, payment status, or driver assignment. Status changes must follow valid transitions and broadcast real-time events to all relevant parties (customer, vendor, driver).
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | Long | Order ID to update | [default to null] |
| UpdateOrderInput | UpdateOrderInput | Update fields for the order |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8