CommerceApi
All URIs are relative to https://business.apis.kesk.app/v1
| Method | HTTP request | Description |
|---|---|---|
| addToCommerceCart | POST /commerce/stores/{vendor_id}/{location_id}/cart/items | Add a product to the e-commerce store cart. |
| clearCommerceCart | DELETE /commerce/stores/{vendor_id}/{location_id}/cart | Clear all items from the e-commerce store cart. |
| getCommerceCart | GET /commerce/stores/{vendor_id}/{location_id}/cart | Get cart for a specific e-commerce store location. |
| getCommerceProduct | GET /commerce/products/{id} | Get commerce product details |
| getCommerceProductQuantityInCart | GET /commerce/stores/{vendor_id}/{location_id}/cart/product/{product_id}/quantity | Get quantity information for a product in the cart. |
| getCommerceStore | GET /commerce/stores/{id} | Get commerce store (location) details |
| listCommerceCategories | GET /commerce/categories | List commerce categories |
| listCommerceProducts | GET /commerce/products | List commerce products |
| listCommerceStores | GET /commerce/stores | List commerce stores (locations) |
| listCommerceSubcategories | GET /commerce/categories/{category_id}/subcategories | List commerce subcategories |
| removeFromCommerceCart | DELETE /commerce/stores/{vendor_id}/{location_id}/cart/items | Remove an item from the e-commerce store cart. |
| updateCommerceCartItem | PUT /commerce/stores/{vendor_id}/{location_id}/cart/items | Update an item in the e-commerce store cart. |
| validateCommerceCartAddition | POST /commerce/stores/{vendor_id}/{location_id}/cart/validate | Validate if a product can be added to the cart. |
addToCommerceCart
CartResponse addToCommerceCart(vendor_id, location_id, AddToCartRequest)
Add a product to the e-commerce store cart.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| location_id | Long | [default to null] | |
| AddToCartRequest | AddToCartRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
clearCommerceCart
String clearCommerceCart(vendor_id, location_id)
Clear all items from the e-commerce store cart.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| location_id | Long | [default to null] |
Return type
String
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getCommerceCart
CartResponse getCommerceCart(vendor_id, location_id)
Get cart for a specific e-commerce store location.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| location_id | Long | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getCommerceProduct
ProductResponse getCommerceProduct(id, authorization)
Get commerce product details
Retrieves detailed information about a specific commerce product, including pricing, availability, and customization options.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | Long | Unique identifier of the product | [default to null] |
| authorization | String | Optional JWT bearer token for authenticated requests | [optional] [default to null] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getCommerceProductQuantityInCart
ProductQuantityResponse getCommerceProductQuantityInCart(vendor_id, location_id, product_id)
Get quantity information for a product in the cart.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| location_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
getCommerceStore
CommerceStoreDetails getCommerceStore(id, authorization)
Get commerce store (location) details
Retrieves detailed information about a specific commerce store location. The ID is the location ID, not the vendor ID.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | Long | Unique identifier of the store (location ID) | [default to null] |
| authorization | String | Optional JWT bearer token for authenticated requests | [optional] [default to null] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listCommerceCategories
List listCommerceCategories()
List commerce categories
Retrieves top-level product categories for commerce stores.
Parameters
This endpoint does not need any parameter.
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listCommerceProducts
ProductListResponse listCommerceProducts(store_id, vendor_id, category_id, sub_category_id, is_open, latitude, longitude, keyword, type, page, per_page, authorization)
List commerce products
Retrieves products from commerce stores with optional filtering by store (location), category, location, and keyword search.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| store_id | Long | Filter by specific store ID (location ID) | [optional] [default to null] |
| vendor_id | Long | Filter by specific vendor ID (company - includes all locations) | [optional] [default to null] |
| category_id | Long | Filter by category ID | [optional] [default to null] |
| sub_category_id | Long | Filter by sub-category ID | [optional] [default to null] |
| is_open | Boolean | Filter to show only products from currently open stores | [optional] [default to null] |
| latitude | Double | User’s latitude for location-based filtering | [optional] [default to null] |
| longitude | Double | User’s longitude for location-based filtering | [optional] [default to null] |
| keyword | String | Search keyword to filter products | [optional] [default to null] |
| type | ProductListType | Filter/sort type: best (most sales), for_you, flash, new, featured | [optional] [default to null] [enum: vendor, normal, best, for_you, flash, new, featured] |
| page | Long | Page number for pagination (default: 1) | [optional] [default to null] |
| per_page | Long | Items per page for pagination (default: 10) | [optional] [default to null] |
| authorization | String | Optional JWT bearer token for authenticated requests | [optional] [default to null] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listCommerceStores
PaginatedResponse_CommerceStoreListItem listCommerceStores(latitude, longitude, radius_km, page, per_page, authorization)
List commerce stores (locations)
Retrieves e-commerce store locations with optional geo-filtering. Each store is a vendor_location - a vendor can have multiple stores. Results are filtered by proximity within 50km if coordinates are provided.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| latitude | Double | Latitude for geo-filtering stores within radius | [optional] [default to null] |
| longitude | Double | Longitude for geo-filtering stores within radius | [optional] [default to null] |
| radius_km | Double | Search radius in kilometers (default: 50) | [optional] [default to null] |
| page | Long | Page number for pagination (default: 1) | [optional] [default to null] |
| per_page | Long | Items per page for pagination (default: 20) | [optional] [default to null] |
| authorization | String | Optional JWT bearer token for authenticated requests | [optional] [default to null] |
Return type
PaginatedResponse_CommerceStoreListItem
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listCommerceSubcategories
List listCommerceSubcategories(category_id)
List commerce subcategories
Retrieves subcategories for a specific commerce category.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| category_id | Long | Parent category ID | [default to null] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
removeFromCommerceCart
CartResponse removeFromCommerceCart(vendor_id, location_id, RemoveFromCartRequest)
Remove an item from the e-commerce store cart.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| location_id | Long | [default to null] | |
| RemoveFromCartRequest | RemoveFromCartRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
updateCommerceCartItem
CartResponse updateCommerceCartItem(vendor_id, location_id, UpdateCartItemRequest)
Update an item in the e-commerce store cart.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| location_id | Long | [default to null] | |
| UpdateCartItemRequest | UpdateCartItemRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
validateCommerceCartAddition
CartValidationResponse validateCommerceCartAddition(vendor_id, location_id, CartValidationRequest)
Validate if a product can be added to the cart.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| vendor_id | Long | [default to null] | |
| location_id | Long | [default to null] | |
| CartValidationRequest | CartValidationRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8