VendorStoreApi
All URIs are relative to https://business.apis.kesk.app/v1
| Method | HTTP request | Description |
|---|---|---|
| createVendorMenu | POST /vendors/{vendor_id}/store-management/menus | Create vendor menu |
| deleteVendorMenu | DELETE /vendors/{vendor_id}/store-management/menus/{menu_id} | Delete vendor menu |
| getVendorStoreAnalytics | GET /vendors/{vendor_id}/store-management/analytics | Get store analytics |
| listVendorCategories | GET /vendors/{vendor_id}/store-management/categories | List vendor categories |
| listVendorMenus | GET /vendors/{vendor_id}/store-management/menus | List vendor menus |
| updateVendorMenu | PUT /vendors/{vendor_id}/store-management/menus/{menu_id} | Update vendor menu |
createVendorMenu
VendorMenuResponse createVendorMenu(vendor_id, CreateVendorMenuRequest)
Create vendor menu
Creates a new menu for organizing products in the vendor’s store. The menu name must be unique within the vendor’s store.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | Unique identifier of the vendor | [default to null] |
| CreateVendorMenuRequest | CreateVendorMenuRequest | Menu creation request with name and optional description |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
deleteVendorMenu
MessageResponse deleteVendorMenu(vendor_id, menu_id)
Delete vendor menu
Permanently removes a menu from the vendor’s store. Products in the menu are not deleted, only the menu grouping is removed.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | Unique identifier of the vendor | [default to null] |
| menu_id | Long | Unique identifier of the menu to delete | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getVendorStoreAnalytics
VendorStoreAnalyticsResponse getVendorStoreAnalytics(vendor_id, start_date, end_date, period)
Get store analytics
Retrieves comprehensive analytics for the vendor’s store including orders, revenue, and product performance. Date range filtering allows vendors to analyze specific time periods for business insights.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | Unique identifier of the vendor | [default to null] |
| start_date | String | Start date for analytics period (ISO 8601 format) | [optional] [default to null] |
| end_date | String | End date for analytics period (ISO 8601 format) | [optional] [default to null] |
| period | String | Aggregation period for time-series data (e.g., “day”, “week”, “month”) | [optional] [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listVendorCategories
PaginatedResponse_VendorCategoryResponse listVendorCategories(vendor_id, per_page, page, search, parent_id, is_active)
List vendor categories
Retrieves all product categories for the vendor’s store with pagination and filtering. Categories support hierarchical organization with parent-child relationships.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | Unique identifier of the vendor | [default to null] |
| per_page | Integer | Number of items per page (default: 10) | [optional] [default to null] |
| page | Integer | Page number to retrieve (default: 1) | [optional] [default to null] |
| search | String | Search term to filter categories by name | [optional] [default to null] |
| parent_id | Long | Filter categories by parent category ID for hierarchical views | [optional] [default to null] |
| is_active | Boolean | Filter categories by active status | [optional] [default to null] |
Return type
PaginatedResponse_VendorCategoryResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listVendorMenus
PaginatedResponse_VendorMenuResponse listVendorMenus(vendor_id, per_page, page, search, is_active)
List vendor menus
Retrieves all menus for the vendor’s store with pagination support. Menus are used to organize products into logical groupings for customers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | Unique identifier of the vendor | [default to null] |
| per_page | Integer | Number of items per page (default: 10) | [optional] [default to null] |
| page | Integer | Page number to retrieve (default: 1) | [optional] [default to null] |
| search | String | Search term to filter menus by name | [optional] [default to null] |
| is_active | Boolean | Filter menus by active status | [optional] [default to null] |
Return type
PaginatedResponse_VendorMenuResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
updateVendorMenu
VendorMenuResponse updateVendorMenu(vendor_id, menu_id, UpdateVendorMenuRequest)
Update vendor menu
Updates an existing menu’s name, description, or display order. Changes take effect immediately in the customer-facing store.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | Unique identifier of the vendor | [default to null] |
| menu_id | Long | Unique identifier of the menu to update | [default to null] |
| UpdateVendorMenuRequest | UpdateVendorMenuRequest | Menu update request with modified fields |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8