VendorLocationsApi
All URIs are relative to https://business.apis.kesk.app/v1
| Method | HTTP request | Description |
|---|---|---|
| createVendorLocation | POST /vendors/{vendor_id}/locations | Create a new vendor location |
| deleteVendorLocation | DELETE /vendors/{vendor_id}/locations/{location_id} | Delete a vendor location |
| getVendorLocation | GET /vendors/{vendor_id}/locations/{location_id} | Get a specific vendor location |
| listVendorLocations | GET /vendors/{vendor_id}/locations | List all locations for a vendor |
| searchNearbyVendorLocations | POST /vendors/{vendor_id}/locations/search-nearby | Search nearby vendor locations by coordinates |
| updateVendorLocation | PUT /vendors/{vendor_id}/locations/{location_id} | Update a vendor location |
createVendorLocation
VendorLocationResponse createVendorLocation(vendor_id, CreateVendorLocationRequest)
Create a new vendor location
Creates a new physical location for the vendor with address, coordinates, and service options. Validates all input data including geographic coordinates and contact information.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | Unique identifier of the vendor | [default to null] |
| CreateVendorLocationRequest | CreateVendorLocationRequest | Location data including address, coordinates, and operational details |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
deleteVendorLocation
MessageResponse deleteVendorLocation(vendor_id, location_id)
Delete a vendor location
Permanently removes a location from the vendor’s account. This operation cannot be undone. Ensure the location is not the primary location before deletion.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | Unique identifier of the vendor | [default to null] |
| location_id | Long | Unique identifier of the location to delete | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getVendorLocation
VendorLocationResponse getVendorLocation(vendor_id, location_id)
Get a specific vendor location
Retrieves detailed information for a single location by its ID. Returns 404 if the location does not exist or does not belong to the vendor.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | Unique identifier of the vendor | [default to null] |
| location_id | Long | Unique identifier of the location to retrieve | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listVendorLocations
PaginatedResponse_VendorLocationResponse listVendorLocations(vendor_id, per_page, page, search, is_active)
List all locations for a vendor
Retrieves a paginated list of all locations belonging to the specified vendor. Supports optional filtering by search term, active status, and primary designation.
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 for pagination (default: 1) | [optional] [default to null] |
| search | String | Optional search term to filter locations by name or address | [optional] [default to null] |
| is_active | Boolean | Optional filter for active/inactive locations | [optional] [default to null] |
Return type
PaginatedResponse_VendorLocationResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
searchNearbyVendorLocations
PaginatedResponse_VendorLocationResponse searchNearbyVendorLocations(vendor_id, LocationSearchRequest, page, per_page)
Search nearby vendor locations by coordinates
Performs geospatial search to find vendor locations within a specified radius of given coordinates. Returns locations sorted by distance from the search point, useful for proximity-based queries.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | Unique identifier of the vendor | [default to null] |
| LocationSearchRequest | LocationSearchRequest | Search parameters including latitude, longitude, and optional radius (default: 10km) | |
| 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_VendorLocationResponse
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
updateVendorLocation
VendorLocationResponse updateVendorLocation(vendor_id, location_id, UpdateVendorLocationRequest)
Update a vendor location
Updates an existing location’s information including address, coordinates, and service settings. Only updates fields that are provided in the request payload.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | Unique identifier of the vendor | [default to null] |
| location_id | Long | Unique identifier of the location to update | [default to null] |
| UpdateVendorLocationRequest | UpdateVendorLocationRequest | Updated location data with optional fields for partial updates |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8