VendorSettingsApi
All URIs are relative to https://business.apis.kesk.app/v1
| Method | HTTP request | Description |
|---|---|---|
| getVendorOperatingHours | GET /vendors/{vendor_id}/settings/operating-hours | Get vendor operating hours |
| getVendorSettings | GET /vendors/{vendor_id}/settings | Get vendor settings |
| updateVendorDeliverySettings | PUT /vendors/{vendor_id}/settings/delivery | Update vendor delivery settings |
| updateVendorOperatingHours | PUT /vendors/{vendor_id}/settings/operating-hours | Update vendor operating hours |
| updateVendorSettings | PUT /vendors/{vendor_id}/settings | Update vendor settings |
getVendorOperatingHours
PaginatedResponse_VendorOperatingHoursResponse getVendorOperatingHours(vendor_id, page, per_page)
Get vendor operating hours
Retrieves weekly schedule configuration showing open and close times for each day. Returns all seven days with closure status and time ranges.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | ID of the vendor to retrieve operating hours for | [default to null] |
| page | Integer | Page number for pagination (default: 1) | [optional] [default to null] |
| per_page | Integer | Number of items per page (default: 20) | [optional] [default to null] |
Return type
PaginatedResponse_VendorOperatingHoursResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getVendorSettings
VendorSettingsResponse getVendorSettings(vendor_id)
Get vendor settings
Retrieves comprehensive configuration settings for the specified vendor including business information, operational preferences, and delivery parameters.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | ID of the vendor to retrieve settings for | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
updateVendorDeliverySettings
MessageResponse updateVendorDeliverySettings(vendor_id, VendorDeliverySettingsRequest)
Update vendor delivery settings
Configures delivery parameters including service range, base fees, and variable charges. Updates apply to all future orders and affect delivery availability calculations.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | ID of the vendor to update delivery settings for | [default to null] |
| VendorDeliverySettingsRequest | VendorDeliverySettingsRequest | Delivery configuration including range limits and fee structure |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
updateVendorOperatingHours
MessageResponse updateVendorOperatingHours(vendor_id, VendorOperatingHoursRequest)
Update vendor operating hours
Configures weekly business hours by updating open times, close times, and closure status for each day. Accepts an array of day configurations for batch updates.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | ID of the vendor to update operating hours for | [default to null] |
| VendorOperatingHoursRequest | List | Array of operating hour configurations for each day of the week |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
updateVendorSettings
VendorSettingsResponse updateVendorSettings(vendor_id, UpdateVendorSettingsRequest)
Update vendor settings
Modifies business configuration including contact information, service options, order limits, and operational preferences. Returns updated settings upon successful validation.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | ID of the vendor to update settings for | [default to null] |
| UpdateVendorSettingsRequest | UpdateVendorSettingsRequest | Updated settings data including business info and operational preferences |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8