FavouriteVendorsApi
All URIs are relative to https://business.apis.kesk.app/v1
| Method | HTTP request | Description |
|---|---|---|
| addFavouriteVendor | POST /favourites/vendors | Add vendor to favourites |
| listFavouriteVendors | GET /favourites/vendors | List favourite vendors |
| removeFavouriteVendor | DELETE /favourites/vendors/{id} | Remove vendor from favourites |
addFavouriteVendor
MessageResponse addFavouriteVendor(AddFavouriteVendorInput)
Add vendor to favourites
Marks a vendor as a favourite for the authenticated user.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| AddFavouriteVendorInput | AddFavouriteVendorInput |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
listFavouriteVendors
PaginatedResponse_FavouriteVendor listFavouriteVendors(page, per_page)
List favourite vendors
Retrieves all vendors the user has marked as favourites.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| page | Integer | [optional] [default to null] | |
| per_page | Integer | [optional] [default to null] |
Return type
PaginatedResponse_FavouriteVendor
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
removeFavouriteVendor
MessageResponse removeFavouriteVendor(id)
Remove vendor from favourites
Removes a vendor from the user’s favourites list.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | Long | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8