RentalsApi
All URIs are relative to https://business.apis.kesk.app/v1
| Method | HTTP request | Description |
|---|---|---|
| calculateRentalLateFee | GET /rentals/orders/{id}/late-fee | Calculate late fee |
| cancelRentalOrder | POST /rentals/orders/{id}/cancel | Cancel rental order |
| checkRentalAvailability | POST /rentals/availability/check | Check rental availability |
| createRentalOrder | POST /rentals/orders | Create rental order |
| getRentalAvailabilityCalendar | GET /rentals/items/{id}/availability/calendar | Get availability calendar |
| getRentalItem | GET /rentals/items/{id} | Get rental item details |
| getRentalOrder | GET /rentals/orders/{id} | Get rental order details |
| getRentalStore | GET /rentals/stores/{id} | Get rental store (location) details |
| listRentalCategories | GET /rentals/categories | List rental categories |
| listRentalItems | GET /rentals/items | List rental items |
| listRentalOrders | GET /rentals/orders | List user’s rental orders |
| listRentalStores | GET /rentals/stores | List rental stores (locations) |
| listRentalSubcategories | GET /rentals/categories/{category_id}/subcategories | List rental subcategories |
calculateRentalLateFee
LateFeeResultResponse calculateRentalLateFee(id)
Calculate late fee
Calculates the current late fee for an overdue rental order. Returns zero if the rental is not overdue.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | Long | Rental order ID | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
cancelRentalOrder
CancellationResultResponse cancelRentalOrder(id, CancelRentalRequest)
Cancel rental order
Cancels a rental order. The refund amount depends on the cancellation policy and how close to the rental start date the cancellation is made.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | Long | Rental order ID | [default to null] |
| CancelRentalRequest | CancelRentalRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
checkRentalAvailability
RentalAvailabilityCheckResponse checkRentalAvailability(CheckRentalAvailabilityRequest)
Check rental availability
Checks if a rental item is available for the specified date range. Returns availability status and any conflicts.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| CheckRentalAvailabilityRequest | CheckRentalAvailabilityRequest |
Return type
RentalAvailabilityCheckResponse
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
createRentalOrder
RentalOrderResponse createRentalOrder(CreateRentalOrderRequest)
Create rental order
Creates a new rental order for the authenticated user. The order will be in ‘pending’ status until payment is confirmed.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| CreateRentalOrderRequest | CreateRentalOrderRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
getRentalAvailabilityCalendar
List getRentalAvailabilityCalendar(id, location_id, start_date, end_date)
Get availability calendar
Retrieves a calendar view of availability for a rental item. Shows available quantities for each day in the specified range.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | Long | Product ID to get calendar for | [default to null] |
| location_id | Long | Location ID to check availability at | [default to null] |
| start_date | String | Start date for calendar (YYYY-MM-DD) | [default to null] |
| end_date | String | End date for calendar (YYYY-MM-DD) | [default to null] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getRentalItem
ProductResponse getRentalItem(id, authorization)
Get rental item details
Retrieves detailed information about a specific rental item, including pricing, availability, and customization options.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | Long | Unique identifier of the rental item | [default to null] |
| authorization | String | Optional JWT bearer token for authenticated requests | [optional] [default to null] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getRentalOrder
RentalOrderResponse getRentalOrder(id)
Get rental order details
Retrieves detailed information about a specific rental order. Only the order owner can access this endpoint.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | Long | Rental order ID | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getRentalStore
RentalStoreDetails getRentalStore(id, authorization)
Get rental store (location) details
Retrieves detailed information about a specific rental store location. The ID is the location ID, not the vendor ID.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | Long | Unique identifier of the rental store (location ID) | [default to null] |
| authorization | String | Optional JWT bearer token for authenticated requests | [optional] [default to null] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listRentalCategories
List listRentalCategories()
List rental categories
Retrieves top-level item categories for rental stores.
Parameters
This endpoint does not need any parameter.
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listRentalItems
ProductListResponse listRentalItems(store_id, vendor_id, category_id, sub_category_id, is_open, latitude, longitude, keyword, page, per_page, authorization)
List rental items
Retrieves items from rental stores with optional filtering by store (location), category, and keyword search.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| store_id | Long | Filter by specific store ID (location ID) | [optional] [default to null] |
| vendor_id | Long | Filter by specific vendor ID (company - includes all locations) | [optional] [default to null] |
| category_id | Long | Filter by category ID | [optional] [default to null] |
| sub_category_id | Long | Filter by sub-category ID | [optional] [default to null] |
| is_open | Boolean | Filter to show only items from currently open stores | [optional] [default to null] |
| latitude | Double | User’s latitude for location-based filtering | [optional] [default to null] |
| longitude | Double | User’s longitude for location-based filtering | [optional] [default to null] |
| keyword | String | Search keyword to filter items | [optional] [default to null] |
| page | Long | Page number for pagination (default: 1) | [optional] [default to null] |
| per_page | Long | Items per page for pagination (default: 10) | [optional] [default to null] |
| authorization | String | Optional JWT bearer token for authenticated requests | [optional] [default to null] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listRentalOrders
PaginatedResponse_RentalOrderListItemResponse listRentalOrders(page, per_page)
List user’s rental orders
Retrieves a paginated list of the authenticated user’s rental orders.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| page | Long | Page number for pagination (default: 1) | [optional] [default to null] |
| per_page | Long | Items per page for pagination (default: 20) | [optional] [default to null] |
Return type
PaginatedResponse_RentalOrderListItemResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listRentalStores
PaginatedResponse_RentalStoreListItem listRentalStores(latitude, longitude, radius_km, page, per_page, authorization)
List rental stores (locations)
Retrieves rental store locations with optional geo-filtering. Each store is a vendor_location - a vendor can have multiple stores. Results are filtered by proximity within 50km if coordinates are provided.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| latitude | Double | Latitude for geo-filtering stores within radius | [optional] [default to null] |
| longitude | Double | Longitude for geo-filtering stores within radius | [optional] [default to null] |
| radius_km | Double | Search radius in kilometers (default: 50) | [optional] [default to null] |
| page | Long | Page number for pagination (default: 1) | [optional] [default to null] |
| per_page | Long | Items per page for pagination (default: 20) | [optional] [default to null] |
| authorization | String | Optional JWT bearer token for authenticated requests | [optional] [default to null] |
Return type
PaginatedResponse_RentalStoreListItem
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listRentalSubcategories
List listRentalSubcategories(category_id)
List rental subcategories
Retrieves subcategories for a specific rental category.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| category_id | Long | Parent category ID | [default to null] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8