VendorProductsApi
All URIs are relative to https://business.apis.kesk.app/v1
| Method | HTTP request | Description |
|---|---|---|
| createVendorProduct | POST /vendors/{vendor_id}/products | Create a new product |
| deleteVendorProduct | DELETE /vendors/{vendor_id}/products/{product_id} | Delete a product |
| getProductInventory | GET /vendors/{vendor_id}/products/{product_id}/inventory | |
| getVendorProduct | GET /vendors/{vendor_id}/products/{product_id} | Retrieve a specific product |
| getVendorProducts | GET /vendors/{vendor_id}/products | List all products for a vendor |
| updateProductInventory | PUT /vendors/{vendor_id}/products/{product_id}/inventory/{location_id} | |
| updateVendorProduct | PUT /vendors/{vendor_id}/products/{product_id} | Update an existing product |
createVendorProduct
ProductResponse createVendorProduct(vendor_id, name, price, category_id, photos, description, is_active)
Create a new product
Adds a new product to the vendor’s catalog with multipart support for photo uploads. Automatically associates the product with the vendor’s default location and currency.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | ID of the vendor creating the product | [default to null] |
| name | String | Name of the product. | [default to null] |
| price | Double | Price of the product. | [default to null] |
| category_id | Long | Category ID for the product. | [default to null] |
| photos | List | Product photos. | [default to null] |
| description | String | Description of the product. | [optional] [default to null] |
| is_active | Boolean | Whether the product is active. | [optional] [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: multipart/form-data
- Accept: application/json; charset=utf-8
deleteVendorProduct
MessageResponse deleteVendorProduct(vendor_id, product_id)
Delete a product
Permanently removes a product from the vendor’s catalog. Verifies product ownership and vendor access before deletion. This action cannot be undone.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | ID of the vendor who owns the product | [default to null] |
| product_id | Long | ID of the product to delete | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getProductInventory
ProductInventoryListResponse getProductInventory(vendor_id, product_id)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| product_id | Long | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getVendorProduct
ProductResponse getVendorProduct(vendor_id, product_id)
Retrieve a specific product
Fetches detailed information about a single product belonging to the vendor. Verifies both vendor access and product ownership before returning the data.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | ID of the vendor who owns the product | [default to null] |
| product_id | Long | ID of the product to retrieve | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getVendorProducts
ProductListResponse getVendorProducts(vendor_id, category_id, sub_category_id, location_id, menu_id, is_open, keyword, sort_by, page, per_page)
List all products for a vendor
Retrieves a paginated list of products belonging to the specified vendor with optional filtering by category, menu, status, and keyword search. Verifies user access to the vendor.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | ID of the vendor whose products to retrieve | [default to null] |
| category_id | Long | Filter products by category ID | [optional] [default to null] |
| sub_category_id | Long | Filter products by sub-category ID | [optional] [default to null] |
| location_id | Long | Filter products by location ID | [optional] [default to null] |
| menu_id | Long | Filter products by menu ID | [optional] [default to null] |
| is_open | Boolean | Filter products by open/closed status | [optional] [default to null] |
| keyword | String | Search keyword for product name or description | [optional] [default to null] |
| sort_by | String | Field name to sort results by | [optional] [default to null] |
| page | Integer | Page number for pagination (default: 1) | [optional] [default to null] |
| per_page | Integer | Number of items per page (default: 10) | [optional] [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
updateProductInventory
ProductLocationInventory updateProductInventory(vendor_id, product_id, location_id, UpdateProductInventoryRequest)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| product_id | Long | [default to null] | |
| location_id | Long | [default to null] | |
| UpdateProductInventoryRequest | UpdateProductInventoryRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
updateVendorProduct
ProductResponse updateVendorProduct(vendor_id, product_id, photos, name, description, price, category_id, is_active)
Update an existing product
Modifies product details including name, price, description, and photos. Only updates fields provided in the request. Verifies product ownership before applying changes.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | ID of the vendor who owns the product | [default to null] |
| product_id | Long | ID of the product to update | [default to null] |
| photos | List | Product photos to add. | [default to null] |
| name | String | Name of the product. | [optional] [default to null] |
| description | String | Description of the product. | [optional] [default to null] |
| price | Double | Price of the product. | [optional] [default to null] |
| category_id | Long | Category ID for the product. | [optional] [default to null] |
| is_active | Boolean | Whether the product is active. | [optional] [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: multipart/form-data
- Accept: application/json; charset=utf-8